AWSLakeFormationClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.lakeformation.AWSLakeFormationClient

All Implemented Interfaces:

AWSLakeFormation

Direct Known Subclasses:

AWSLakeFormationAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSLakeFormationClient
extends AmazonWebServiceClient
implements AWSLakeFormation
```
Client for accessing AWS Lake Formation. All service calls made using this client are blocking, and will not return until the service call completes.
Lake Formation
Defines the public endpoint for the Lake Formation service.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.lakeformation.AWSLakeFormation
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddLFTagsToResourceResult`	`addLFTagsToResource(AddLFTagsToResourceRequest request)` Attaches one or more LF-tags to an existing resource.
`BatchGrantPermissionsResult`	`batchGrantPermissions(BatchGrantPermissionsRequest request)` Batch operation to grant permissions to the principal.
`BatchRevokePermissionsResult`	`batchRevokePermissions(BatchRevokePermissionsRequest request)` Batch operation to revoke permissions from the principal.
`static AWSLakeFormationClientBuilder`	`builder()`
`CancelTransactionResult`	`cancelTransaction(CancelTransactionRequest request)` Attempts to cancel the specified transaction.
`CommitTransactionResult`	`commitTransaction(CommitTransactionRequest request)` Attempts to commit the specified transaction.
`CreateDataCellsFilterResult`	`createDataCellsFilter(CreateDataCellsFilterRequest request)` Creates a data cell filter to allow one to grant access to certain columns on certain rows.
`CreateLFTagResult`	`createLFTag(CreateLFTagRequest request)` Creates an LF-tag with the specified name and values.
`DeleteDataCellsFilterResult`	`deleteDataCellsFilter(DeleteDataCellsFilterRequest request)` Deletes a data cell filter.
`DeleteLFTagResult`	`deleteLFTag(DeleteLFTagRequest request)` Deletes the specified LF-tag key name.
`DeleteObjectsOnCancelResult`	`deleteObjectsOnCancel(DeleteObjectsOnCancelRequest request)` 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.
`DeregisterResourceResult`	`deregisterResource(DeregisterResourceRequest request)` Deregisters the resource as managed by the Data Catalog.
`DescribeResourceResult`	`describeResource(DescribeResourceRequest request)` Retrieves the current data access role for the given resource registered in Lake Formation.
`DescribeTransactionResult`	`describeTransaction(DescribeTransactionRequest request)` Returns the details of a single transaction.
`ExtendTransactionResult`	`extendTransaction(ExtendTransactionRequest request)` Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetDataLakeSettingsResult`	`getDataLakeSettings(GetDataLakeSettingsRequest request)` Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
`GetEffectivePermissionsForPathResult`	`getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest request)` Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
`GetLFTagResult`	`getLFTag(GetLFTagRequest request)` Returns an LF-tag definition.
`GetQueryStateResult`	`getQueryState(GetQueryStateRequest request)` Returns the state of a query previously submitted.
`GetQueryStatisticsResult`	`getQueryStatistics(GetQueryStatisticsRequest request)` Retrieves statistics on the planning and execution of a query.
`GetResourceLFTagsResult`	`getResourceLFTags(GetResourceLFTagsRequest request)` Returns the LF-tags applied to a resource.
`GetTableObjectsResult`	`getTableObjects(GetTableObjectsRequest request)` Returns the set of Amazon S3 objects that make up the specified governed table.
`GetTemporaryGluePartitionCredentialsResult`	`getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest request)` This API is identical to `GetTemporaryTableCredentials` except that this is used when the target Data Catalog resource is of type Partition.
`GetTemporaryGlueTableCredentialsResult`	`getTemporaryGlueTableCredentials(GetTemporaryGlueTableCredentialsRequest request)` Allows a caller in a secure environment to assume a role with permission to access Amazon S3.
`GetWorkUnitResultsResult`	`getWorkUnitResults(GetWorkUnitResultsRequest request)` Returns the work units resulting from the query.
`GetWorkUnitsResult`	`getWorkUnits(GetWorkUnitsRequest request)` Retrieves the work units generated by the `StartQueryPlanning` operation.
`GrantPermissionsResult`	`grantPermissions(GrantPermissionsRequest request)` Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
`ListDataCellsFilterResult`	`listDataCellsFilter(ListDataCellsFilterRequest request)` Lists all the data cell filters on a table.
`ListLFTagsResult`	`listLFTags(ListLFTagsRequest request)` Lists LF-tags that the requester has permission to view.
`ListPermissionsResult`	`listPermissions(ListPermissionsRequest request)` Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
`ListResourcesResult`	`listResources(ListResourcesRequest request)` Lists the resources registered to be managed by the Data Catalog.
`ListTableStorageOptimizersResult`	`listTableStorageOptimizers(ListTableStorageOptimizersRequest request)` Returns the configuration of all storage optimizers associated with a specified table.
`ListTransactionsResult`	`listTransactions(ListTransactionsRequest request)` Returns metadata about transactions and their status.
`PutDataLakeSettingsResult`	`putDataLakeSettings(PutDataLakeSettingsRequest request)` Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
`RegisterResourceResult`	`registerResource(RegisterResourceRequest request)` Registers the resource as managed by the Data Catalog.
`RemoveLFTagsFromResourceResult`	`removeLFTagsFromResource(RemoveLFTagsFromResourceRequest request)` Removes an LF-tag from the resource.
`RevokePermissionsResult`	`revokePermissions(RevokePermissionsRequest request)` Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
`SearchDatabasesByLFTagsResult`	`searchDatabasesByLFTags(SearchDatabasesByLFTagsRequest request)` This operation allows a search on `DATABASE` resources by `TagCondition`.
`SearchTablesByLFTagsResult`	`searchTablesByLFTags(SearchTablesByLFTagsRequest request)` This operation allows a search on `TABLE` resources by `LFTag`s.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartQueryPlanningResult`	`startQueryPlanning(StartQueryPlanningRequest request)` Submits a request to process a query statement.
`StartTransactionResult`	`startTransaction(StartTransactionRequest request)` Starts a new transaction and returns its transaction ID.
`UpdateLFTagResult`	`updateLFTag(UpdateLFTagRequest request)` Updates the list of possible values for the specified LF-tag key.
`UpdateResourceResult`	`updateResource(UpdateResourceRequest request)` Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
`UpdateTableObjectsResult`	`updateTableObjects(UpdateTableObjectsRequest request)` Updates the manifest of Amazon S3 objects that make up the specified governed table.
`UpdateTableStorageOptimizerResult`	`updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest request)` Updates the configuration of the storage optimizers for a table.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSLakeFormationClientBuilder builder()
```
  - addLFTagsToResource
```
public AddLFTagsToResourceResult addLFTagsToResource(AddLFTagsToResourceRequest request)
```
    Attaches one or more LF-tags to an existing resource.
    
    Specified by:
    
    addLFTagsToResource in interface AWSLakeFormation
    
    Parameters:
    
    addLFTagsToResourceRequest -
    
    Returns:
    
    Result of the AddLFTagsToResource operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    AccessDeniedException - Access to a resource was denied.
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    See Also:
    
    AWS API Documentation
  - batchGrantPermissions
```
public BatchGrantPermissionsResult batchGrantPermissions(BatchGrantPermissionsRequest request)
```
    Batch operation to grant permissions to the principal.
    
    Specified by:
    
    batchGrantPermissions in interface AWSLakeFormation
    
    Parameters:
    
    batchGrantPermissionsRequest -
    
    Returns:
    
    Result of the BatchGrantPermissions operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    See Also:
    
    AWS API Documentation
  - batchRevokePermissions
```
public BatchRevokePermissionsResult batchRevokePermissions(BatchRevokePermissionsRequest request)
```
    Batch operation to revoke permissions from the principal.
    
    Specified by:
    
    batchRevokePermissions in interface AWSLakeFormation
    
    Parameters:
    
    batchRevokePermissionsRequest -
    
    Returns:
    
    Result of the BatchRevokePermissions operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    See Also:
    
    AWS API Documentation
  - cancelTransaction
```
public CancelTransactionResult cancelTransaction(CancelTransactionRequest request)
```
    Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
    
    Specified by:
    
    cancelTransaction in interface AWSLakeFormation
    
    Parameters:
    
    cancelTransactionRequest -
    
    Returns:
    
    Result of the CancelTransaction operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    EntityNotFoundException - A specified entity does not exist
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    TransactionCommittedException - Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.
    
    TransactionCommitInProgressException - Contains details about an error related to a transaction commit that was in progress.
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    See Also:
    
    AWS API Documentation
  - commitTransaction
```
public CommitTransactionResult commitTransaction(CommitTransactionRequest request)
```
    Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.
    
    Specified by:
    
    commitTransaction in interface AWSLakeFormation
    
    Parameters:
    
    commitTransactionRequest -
    
    Returns:
    
    Result of the CommitTransaction operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    EntityNotFoundException - A specified entity does not exist
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    TransactionCanceledException - Contains details about an error related to a transaction that was cancelled.
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    See Also:
    
    AWS API Documentation
  - createDataCellsFilter
```
public CreateDataCellsFilterResult createDataCellsFilter(CreateDataCellsFilterRequest request)
```
    Creates a data cell filter to allow one to grant access to certain columns on certain rows.
    
    Specified by:
    
    createDataCellsFilter in interface AWSLakeFormation
    
    Parameters:
    
    createDataCellsFilterRequest -
    
    Returns:
    
    Result of the CreateDataCellsFilter operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - A resource to be created or added already exists.
    
    InvalidInputException - The input provided was not valid.
    
    EntityNotFoundException - A specified entity does not exist
    
    ResourceNumberLimitExceededException - A resource numerical limit was exceeded.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - createLFTag
```
public CreateLFTagResult createLFTag(CreateLFTagRequest request)
```
    Creates an LF-tag with the specified name and values.
    
    Specified by:
    
    createLFTag in interface AWSLakeFormation
    
    Parameters:
    
    createLFTagRequest -
    
    Returns:
    
    Result of the CreateLFTag operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    ResourceNumberLimitExceededException - A resource numerical limit was exceeded.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - deleteDataCellsFilter
```
public DeleteDataCellsFilterResult deleteDataCellsFilter(DeleteDataCellsFilterRequest request)
```
    Deletes a data cell filter.
    
    Specified by:
    
    deleteDataCellsFilter in interface AWSLakeFormation
    
    Parameters:
    
    deleteDataCellsFilterRequest -
    
    Returns:
    
    Result of the DeleteDataCellsFilter operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    EntityNotFoundException - A specified entity does not exist
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - deleteLFTag
```
public DeleteLFTagResult deleteLFTag(DeleteLFTagRequest request)
```
    Deletes the specified LF-tag key name. If the attribute key does not exist or the LF-tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message "Delete not allowed" as the LF-tag key is still attached with resources. You can consider untagging resources with this LF-tag key.
    
    Specified by:
    
    deleteLFTag in interface AWSLakeFormation
    
    Parameters:
    
    deleteLFTagRequest -
    
    Returns:
    
    Result of the DeleteLFTag operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - deleteObjectsOnCancel
```
public DeleteObjectsOnCancelResult deleteObjectsOnCancel(DeleteObjectsOnCancelRequest request)
```
    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. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.
    
    The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically call DeleteObjectsOnCancel before writes. For more information, see Rolling Back Amazon S3 Writes.
    
    Specified by:
    
    deleteObjectsOnCancel in interface AWSLakeFormation
    
    Parameters:
    
    deleteObjectsOnCancelRequest -
    
    Returns:
    
    Result of the DeleteObjectsOnCancel operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    EntityNotFoundException - A specified entity does not exist
    
    TransactionCommittedException - Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.
    
    TransactionCanceledException - Contains details about an error related to a transaction that was cancelled.
    
    ResourceNotReadyException - Contains details about an error related to a resource which is not ready for a transaction.
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    See Also:
    
    AWS API Documentation
  - deregisterResource
```
public DeregisterResourceResult deregisterResource(DeregisterResourceRequest request)
```
    Deregisters the resource as managed by the Data Catalog.
    
    When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
    
    Specified by:
    
    deregisterResource in interface AWSLakeFormation
    
    Parameters:
    
    deregisterResourceRequest -
    
    Returns:
    
    Result of the DeregisterResource operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    EntityNotFoundException - A specified entity does not exist
    
    See Also:
    
    AWS API Documentation
  - describeResource
```
public DescribeResourceResult describeResource(DescribeResourceRequest request)
```
    Retrieves the current data access role for the given resource registered in Lake Formation.
    
    Specified by:
    
    describeResource in interface AWSLakeFormation
    
    Parameters:
    
    describeResourceRequest -
    
    Returns:
    
    Result of the DescribeResource operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    EntityNotFoundException - A specified entity does not exist
    
    See Also:
    
    AWS API Documentation
  - describeTransaction
```
public DescribeTransactionResult describeTransaction(DescribeTransactionRequest request)
```
    Returns the details of a single transaction.
    
    Specified by:
    
    describeTransaction in interface AWSLakeFormation
    
    Parameters:
    
    describeTransactionRequest -
    
    Returns:
    
    Result of the DescribeTransaction operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    See Also:
    
    AWS API Documentation
  - extendTransaction
```
public ExtendTransactionResult extendTransaction(ExtendTransactionRequest request)
```
    Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
    
    Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.
    
    Specified by:
    
    extendTransaction in interface AWSLakeFormation
    
    Parameters:
    
    extendTransactionRequest -
    
    Returns:
    
    Result of the ExtendTransaction operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    EntityNotFoundException - A specified entity does not exist
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    TransactionCommittedException - Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.
    
    TransactionCanceledException - Contains details about an error related to a transaction that was cancelled.
    
    TransactionCommitInProgressException - Contains details about an error related to a transaction commit that was in progress.
    
    See Also:
    
    AWS API Documentation
  - getDataLakeSettings
```
public GetDataLakeSettingsResult getDataLakeSettings(GetDataLakeSettingsRequest request)
```
    Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
    
    Specified by:
    
    getDataLakeSettings in interface AWSLakeFormation
    
    Parameters:
    
    getDataLakeSettingsRequest -
    
    Returns:
    
    Result of the GetDataLakeSettings operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    EntityNotFoundException - A specified entity does not exist
    
    See Also:
    
    AWS API Documentation
  - getEffectivePermissionsForPath
```
public GetEffectivePermissionsForPathResult getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest request)
```
    Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.
    
    Specified by:
    
    getEffectivePermissionsForPath in interface AWSLakeFormation
    
    Parameters:
    
    getEffectivePermissionsForPathRequest -
    
    Returns:
    
    Result of the GetEffectivePermissionsForPath operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    EntityNotFoundException - A specified entity does not exist
    
    OperationTimeoutException - The operation timed out.
    
    InternalServiceException - An internal service error occurred.
    
    See Also:
    
    AWS API Documentation
  - getLFTag
```
public GetLFTagResult getLFTag(GetLFTagRequest request)
```
    Returns an LF-tag definition.
    
    Specified by:
    
    getLFTag in interface AWSLakeFormation
    
    Parameters:
    
    getLFTagRequest -
    
    Returns:
    
    Result of the GetLFTag operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - getQueryState
```
public GetQueryStateResult getQueryState(GetQueryStateRequest request)
```
    Returns the state of a query previously submitted. Clients are expected to poll GetQueryState to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to StartQueryPlanning.
    
    Specified by:
    
    getQueryState in interface AWSLakeFormation
    
    Parameters:
    
    getQueryStateRequest -
    
    Returns:
    
    Result of the GetQueryState operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - getQueryStatistics
```
public GetQueryStatisticsResult getQueryStatistics(GetQueryStatisticsRequest request)
```
    Retrieves statistics on the planning and execution of a query.
    
    Specified by:
    
    getQueryStatistics in interface AWSLakeFormation
    
    Parameters:
    
    getQueryStatisticsRequest -
    
    Returns:
    
    Result of the GetQueryStatistics operation returned by the service.
    
    Throws:
    
    StatisticsNotReadyYetException - Contains details about an error related to statistics not being ready.
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    AccessDeniedException - Access to a resource was denied.
    
    ExpiredException - Contains details about an error where the query request expired.
    
    ThrottledException - Contains details about an error where the query request was throttled.
    
    See Also:
    
    AWS API Documentation
  - getResourceLFTags
```
public GetResourceLFTagsResult getResourceLFTags(GetResourceLFTagsRequest request)
```
    Returns the LF-tags applied to a resource.
    
    Specified by:
    
    getResourceLFTags in interface AWSLakeFormation
    
    Parameters:
    
    getResourceLFTagsRequest -
    
    Returns:
    
    Result of the GetResourceLFTags operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    GlueEncryptionException - An encryption operation failed.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - getTableObjects
```
public GetTableObjectsResult getTableObjects(GetTableObjectsRequest request)
```
    Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
    
    Specified by:
    
    getTableObjects in interface AWSLakeFormation
    
    Parameters:
    
    getTableObjectsRequest -
    
    Returns:
    
    Result of the GetTableObjects operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    TransactionCommittedException - Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.
    
    TransactionCanceledException - Contains details about an error related to a transaction that was cancelled.
    
    ResourceNotReadyException - Contains details about an error related to a resource which is not ready for a transaction.
    
    See Also:
    
    AWS API Documentation
  - getTemporaryGluePartitionCredentials
```
public GetTemporaryGluePartitionCredentialsResult getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest request)
```
    This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix.
    
    Specified by:
    
    getTemporaryGluePartitionCredentials in interface AWSLakeFormation
    
    Parameters:
    
    getTemporaryGluePartitionCredentialsRequest -
    
    Returns:
    
    Result of the GetTemporaryGluePartitionCredentials operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    EntityNotFoundException - A specified entity does not exist
    
    AccessDeniedException - Access to a resource was denied.
    
    PermissionTypeMismatchException - The engine does not support filtering data based on the enforced permissions. For example, if you call the GetTemporaryGlueTableCredentials operation with SupportedPermissionType equal to ColumnPermission, but cell-level permissions exist on the table, this exception is thrown.
    
    See Also:
    
    AWS API Documentation
  - getTemporaryGlueTableCredentials
```
public GetTemporaryGlueTableCredentialsResult getTemporaryGlueTableCredentials(GetTemporaryGlueTableCredentialsRequest request)
```
    Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
    
    Specified by:
    
    getTemporaryGlueTableCredentials in interface AWSLakeFormation
    
    Parameters:
    
    getTemporaryGlueTableCredentialsRequest -
    
    Returns:
    
    Result of the GetTemporaryGlueTableCredentials operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    EntityNotFoundException - A specified entity does not exist
    
    AccessDeniedException - Access to a resource was denied.
    
    PermissionTypeMismatchException - The engine does not support filtering data based on the enforced permissions. For example, if you call the GetTemporaryGlueTableCredentials operation with SupportedPermissionType equal to ColumnPermission, but cell-level permissions exist on the table, this exception is thrown.
    
    See Also:
    
    AWS API Documentation
  - getWorkUnitResults
```
public GetWorkUnitResultsResult getWorkUnitResults(GetWorkUnitResultsRequest request)
```
    Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
    
    Specified by:
    
    getWorkUnitResults in interface AWSLakeFormation
    
    Parameters:
    
    getWorkUnitResultsRequest -
    
    Returns:
    
    Result of the GetWorkUnitResults operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    AccessDeniedException - Access to a resource was denied.
    
    ExpiredException - Contains details about an error where the query request expired.
    
    ThrottledException - Contains details about an error where the query request was throttled.
    
    See Also:
    
    AWS API Documentation
  - getWorkUnits
```
public GetWorkUnitsResult getWorkUnits(GetWorkUnitsRequest request)
```
    Retrieves the work units generated by the StartQueryPlanning operation.
    
    Specified by:
    
    getWorkUnits in interface AWSLakeFormation
    
    Parameters:
    
    getWorkUnitsRequest -
    
    Returns:
    
    Result of the GetWorkUnits operation returned by the service.
    
    Throws:
    
    WorkUnitsNotReadyYetException - Contains details about an error related to work units not being ready.
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    AccessDeniedException - Access to a resource was denied.
    
    ExpiredException - Contains details about an error where the query request expired.
    
    See Also:
    
    AWS API Documentation
  - grantPermissions
```
public GrantPermissionsResult grantPermissions(GrantPermissionsRequest request)
```
    Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
    
    For information about permissions, see Security and Access Control to Metadata and Data.
    
    Specified by:
    
    grantPermissions in interface AWSLakeFormation
    
    Parameters:
    
    grantPermissionsRequest -
    
    Returns:
    
    Result of the GrantPermissions operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    See Also:
    
    AWS API Documentation
  - listDataCellsFilter
```
public ListDataCellsFilterResult listDataCellsFilter(ListDataCellsFilterRequest request)
```
    Lists all the data cell filters on a table.
    
    Specified by:
    
    listDataCellsFilter in interface AWSLakeFormation
    
    Parameters:
    
    listDataCellsFilterRequest -
    
    Returns:
    
    Result of the ListDataCellsFilter operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    InternalServiceException - An internal service error occurred.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - listLFTags
```
public ListLFTagsResult listLFTags(ListLFTagsRequest request)
```
    Lists LF-tags that the requester has permission to view.
    
    Specified by:
    
    listLFTags in interface AWSLakeFormation
    
    Parameters:
    
    listLFTagsRequest -
    
    Returns:
    
    Result of the ListLFTags operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - listPermissions
```
public ListPermissionsResult listPermissions(ListPermissionsRequest request)
```
    Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
    
    This operation returns only those permissions that have been explicitly granted.
    
    For information about permissions, see Security and Access Control to Metadata and Data.
    
    Specified by:
    
    listPermissions in interface AWSLakeFormation
    
    Parameters:
    
    listPermissionsRequest -
    
    Returns:
    
    Result of the ListPermissions operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    InternalServiceException - An internal service error occurred.
    
    See Also:
    
    AWS API Documentation
  - listResources
```
public ListResourcesResult listResources(ListResourcesRequest request)
```
    Lists the resources registered to be managed by the Data Catalog.
    
    Specified by:
    
    listResources in interface AWSLakeFormation
    
    Parameters:
    
    listResourcesRequest -
    
    Returns:
    
    Result of the ListResources operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    See Also:
    
    AWS API Documentation
  - listTableStorageOptimizers
```
public ListTableStorageOptimizersResult listTableStorageOptimizers(ListTableStorageOptimizersRequest request)
```
    Returns the configuration of all storage optimizers associated with a specified table.
    
    Specified by:
    
    listTableStorageOptimizers in interface AWSLakeFormation
    
    Parameters:
    
    listTableStorageOptimizersRequest -
    
    Returns:
    
    Result of the ListTableStorageOptimizers operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    AccessDeniedException - Access to a resource was denied.
    
    InternalServiceException - An internal service error occurred.
    
    See Also:
    
    AWS API Documentation
  - listTransactions
```
public ListTransactionsResult listTransactions(ListTransactionsRequest request)
```
    Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
    
    This operation can help you identify uncommitted transactions or to get information about transactions.
    
    Specified by:
    
    listTransactions in interface AWSLakeFormation
    
    Parameters:
    
    listTransactionsRequest -
    
    Returns:
    
    Result of the ListTransactions operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    See Also:
    
    AWS API Documentation
  - putDataLakeSettings
```
public PutDataLakeSettingsResult putDataLakeSettings(PutDataLakeSettingsRequest request)
```
    Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
    
    This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
    
    Specified by:
    
    putDataLakeSettings in interface AWSLakeFormation
    
    Parameters:
    
    putDataLakeSettingsRequest -
    
    Returns:
    
    Result of the PutDataLakeSettings operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    See Also:
    
    AWS API Documentation
  - registerResource
```
public RegisterResourceResult registerResource(RegisterResourceRequest request)
```
    Registers the resource as managed by the Data Catalog.
    
    To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
    
    The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
    
    ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true
    
    If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:
    
    arn:aws:iam::12345:role/my-data-access-role
    
    Specified by:
    
    registerResource in interface AWSLakeFormation
    
    Parameters:
    
    registerResourceRequest -
    
    Returns:
    
    Result of the RegisterResource operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    AlreadyExistsException - A resource to be created or added already exists.
    
    EntityNotFoundException - A specified entity does not exist
    
    ResourceNumberLimitExceededException - A resource numerical limit was exceeded.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - removeLFTagsFromResource
```
public RemoveLFTagsFromResourceResult removeLFTagsFromResource(RemoveLFTagsFromResourceRequest request)
```
    Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input.
    
    Specified by:
    
    removeLFTagsFromResource in interface AWSLakeFormation
    
    Parameters:
    
    removeLFTagsFromResourceRequest -
    
    Returns:
    
    Result of the RemoveLFTagsFromResource operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    GlueEncryptionException - An encryption operation failed.
    
    AccessDeniedException - Access to a resource was denied.
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    See Also:
    
    AWS API Documentation
  - revokePermissions
```
public RevokePermissionsResult revokePermissions(RevokePermissionsRequest request)
```
    Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
    
    Specified by:
    
    revokePermissions in interface AWSLakeFormation
    
    Parameters:
    
    revokePermissionsRequest -
    
    Returns:
    
    Result of the RevokePermissions operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    See Also:
    
    AWS API Documentation
  - searchDatabasesByLFTags
```
public SearchDatabasesByLFTagsResult searchDatabasesByLFTags(SearchDatabasesByLFTagsRequest request)
```
    This operation allows a search on DATABASE resources by TagCondition. This operation is used by admins who want to grant user permissions on certain TagConditions. Before making a grant, the admin can use SearchDatabasesByTags to find all resources where the given TagConditions are valid to verify whether the returned resources can be shared.
    
    Specified by:
    
    searchDatabasesByLFTags in interface AWSLakeFormation
    
    Parameters:
    
    searchDatabasesByLFTagsRequest -
    
    Returns:
    
    Result of the SearchDatabasesByLFTags operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    GlueEncryptionException - An encryption operation failed.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - searchTablesByLFTags
```
public SearchTablesByLFTagsResult searchTablesByLFTags(SearchTablesByLFTagsRequest request)
```
    This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use SearchTablesByLFTags to find all resources where the given LFTags are valid to verify whether the returned resources can be shared.
    
    Specified by:
    
    searchTablesByLFTags in interface AWSLakeFormation
    
    Parameters:
    
    searchTablesByLFTagsRequest -
    
    Returns:
    
    Result of the SearchTablesByLFTags operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    GlueEncryptionException - An encryption operation failed.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - startQueryPlanning
```
public StartQueryPlanningResult startQueryPlanning(StartQueryPlanningRequest request)
```
    Submits a request to process a query statement.
    
    This operation generates work units that can be retrieved with the GetWorkUnits operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.
    
    Specified by:
    
    startQueryPlanning in interface AWSLakeFormation
    
    Parameters:
    
    startQueryPlanningRequest -
    
    Returns:
    
    Result of the StartQueryPlanning operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    AccessDeniedException - Access to a resource was denied.
    
    ThrottledException - Contains details about an error where the query request was throttled.
    
    See Also:
    
    AWS API Documentation
  - startTransaction
```
public StartTransactionResult startTransaction(StartTransactionRequest request)
```
    Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
    
    Specified by:
    
    startTransaction in interface AWSLakeFormation
    
    Parameters:
    
    startTransactionRequest -
    
    Returns:
    
    Result of the StartTransaction operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    See Also:
    
    AWS API Documentation
  - updateLFTag
```
public UpdateLFTagResult updateLFTag(UpdateLFTagRequest request)
```
    Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.
    
    Specified by:
    
    updateLFTag in interface AWSLakeFormation
    
    Parameters:
    
    updateLFTagRequest -
    
    Returns:
    
    Result of the UpdateLFTag operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    AccessDeniedException - Access to a resource was denied.
    
    See Also:
    
    AWS API Documentation
  - updateResource
```
public UpdateResourceResult updateResource(UpdateResourceRequest request)
```
    Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
    
    Specified by:
    
    updateResource in interface AWSLakeFormation
    
    Parameters:
    
    updateResourceRequest -
    
    Returns:
    
    Result of the UpdateResource operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    EntityNotFoundException - A specified entity does not exist
    
    See Also:
    
    AWS API Documentation
  - updateTableObjects
```
public UpdateTableObjectsResult updateTableObjects(UpdateTableObjectsRequest request)
```
    Updates the manifest of Amazon S3 objects that make up the specified governed table.
    
    Specified by:
    
    updateTableObjects in interface AWSLakeFormation
    
    Parameters:
    
    updateTableObjectsRequest -
    
    Returns:
    
    Result of the UpdateTableObjects operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    EntityNotFoundException - A specified entity does not exist
    
    TransactionCommittedException - Contains details about an error where the specified transaction has already been committed and cannot be used for UpdateTableObjects.
    
    TransactionCanceledException - Contains details about an error related to a transaction that was cancelled.
    
    TransactionCommitInProgressException - Contains details about an error related to a transaction commit that was in progress.
    
    ResourceNotReadyException - Contains details about an error related to a resource which is not ready for a transaction.
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    See Also:
    
    AWS API Documentation
  - updateTableStorageOptimizer
```
public UpdateTableStorageOptimizerResult updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest request)
```
    Updates the configuration of the storage optimizers for a table.
    
    Specified by:
    
    updateTableStorageOptimizer in interface AWSLakeFormation
    
    Parameters:
    
    updateTableStorageOptimizerRequest -
    
    Returns:
    
    Result of the UpdateTableStorageOptimizer operation returned by the service.
    
    Throws:
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    AccessDeniedException - Access to a resource was denied.
    
    InternalServiceException - An internal service error occurred.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSLakeFormation
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSLakeFormation
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AWSLakeFormationClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.lakeformation.AWSLakeFormation

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

addLFTagsToResource

batchGrantPermissions

batchRevokePermissions

cancelTransaction

commitTransaction

createDataCellsFilter

createLFTag

deleteDataCellsFilter

deleteLFTag

deleteObjectsOnCancel

deregisterResource

describeResource

describeTransaction

extendTransaction

getDataLakeSettings

getEffectivePermissionsForPath

getLFTag

getQueryState

getQueryStatistics

getResourceLFTags

getTableObjects

getTemporaryGluePartitionCredentials

getTemporaryGlueTableCredentials

getWorkUnitResults

getWorkUnits

grantPermissions

listDataCellsFilter

listLFTags

listPermissions

listResources

listTableStorageOptimizers

listTransactions

putDataLakeSettings

registerResource

removeLFTagsFromResource

revokePermissions

searchDatabasesByLFTags

searchTablesByLFTags

startQueryPlanning

startTransaction

updateLFTag

updateResource

updateTableObjects

updateTableStorageOptimizer

getCachedResponseMetadata

shutdown