@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSLakeFormation
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSLakeFormation
instead.
Defines the public endpoint for the Lake Formation service.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AddLFTagsToResourceResult |
addLFTagsToResource(AddLFTagsToResourceRequest addLFTagsToResourceRequest)
Attaches one or more LF-tags to an existing resource.
|
AssumeDecoratedRoleWithSAMLResult |
assumeDecoratedRoleWithSAML(AssumeDecoratedRoleWithSAMLRequest assumeDecoratedRoleWithSAMLRequest)
Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the
request.
|
BatchGrantPermissionsResult |
batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
|
BatchRevokePermissionsResult |
batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
|
CancelTransactionResult |
cancelTransaction(CancelTransactionRequest cancelTransactionRequest)
Attempts to cancel the specified transaction.
|
CommitTransactionResult |
commitTransaction(CommitTransactionRequest commitTransactionRequest)
Attempts to commit the specified transaction.
|
CreateDataCellsFilterResult |
createDataCellsFilter(CreateDataCellsFilterRequest createDataCellsFilterRequest)
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
|
CreateLakeFormationIdentityCenterConfigurationResult |
createLakeFormationIdentityCenterConfiguration(CreateLakeFormationIdentityCenterConfigurationRequest createLakeFormationIdentityCenterConfigurationRequest)
Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to
access Data Catalog resources.
|
CreateLakeFormationOptInResult |
createLakeFormationOptIn(CreateLakeFormationOptInRequest createLakeFormationOptInRequest)
Enforce Lake Formation permissions for the given databases, tables, and principals.
|
CreateLFTagResult |
createLFTag(CreateLFTagRequest createLFTagRequest)
Creates an LF-tag with the specified name and values.
|
DeleteDataCellsFilterResult |
deleteDataCellsFilter(DeleteDataCellsFilterRequest deleteDataCellsFilterRequest)
Deletes a data cell filter.
|
DeleteLakeFormationIdentityCenterConfigurationResult |
deleteLakeFormationIdentityCenterConfiguration(DeleteLakeFormationIdentityCenterConfigurationRequest deleteLakeFormationIdentityCenterConfigurationRequest)
Deletes an IAM Identity Center connection with Lake Formation.
|
DeleteLakeFormationOptInResult |
deleteLakeFormationOptIn(DeleteLakeFormationOptInRequest deleteLakeFormationOptInRequest)
Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
|
DeleteLFTagResult |
deleteLFTag(DeleteLFTagRequest deleteLFTagRequest)
Deletes the specified LF-tag given a key name.
|
DeleteObjectsOnCancelResult |
deleteObjectsOnCancel(DeleteObjectsOnCancelRequest deleteObjectsOnCancelRequest)
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 deregisterResourceRequest)
Deregisters the resource as managed by the Data Catalog.
|
DescribeLakeFormationIdentityCenterConfigurationResult |
describeLakeFormationIdentityCenterConfiguration(DescribeLakeFormationIdentityCenterConfigurationRequest describeLakeFormationIdentityCenterConfigurationRequest)
Retrieves the instance ARN and application ARN for the connection.
|
DescribeResourceResult |
describeResource(DescribeResourceRequest describeResourceRequest)
Retrieves the current data access role for the given resource registered in Lake Formation.
|
DescribeTransactionResult |
describeTransaction(DescribeTransactionRequest describeTransactionRequest)
Returns the details of a single transaction.
|
ExtendTransactionResult |
extendTransaction(ExtendTransactionRequest extendTransactionRequest)
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.
|
GetDataCellsFilterResult |
getDataCellsFilter(GetDataCellsFilterRequest getDataCellsFilterRequest)
Returns a data cells filter.
|
GetDataLakePrincipalResult |
getDataLakePrincipal(GetDataLakePrincipalRequest getDataLakePrincipalRequest)
Returns the identity of the invoking principal.
|
GetDataLakeSettingsResult |
getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
|
GetEffectivePermissionsForPathResult |
getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
GetLFTagResult |
getLFTag(GetLFTagRequest getLFTagRequest)
Returns an LF-tag definition.
|
GetQueryStateResult |
getQueryState(GetQueryStateRequest getQueryStateRequest)
Returns the state of a query previously submitted.
|
GetQueryStatisticsResult |
getQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest)
Retrieves statistics on the planning and execution of a query.
|
GetResourceLFTagsResult |
getResourceLFTags(GetResourceLFTagsRequest getResourceLFTagsRequest)
Returns the LF-tags applied to a resource.
|
GetTableObjectsResult |
getTableObjects(GetTableObjectsRequest getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table.
|
GetTemporaryGluePartitionCredentialsResult |
getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest getTemporaryGluePartitionCredentialsRequest)
This API is identical to
GetTemporaryTableCredentials except that this is used when the target Data
Catalog resource is of type Partition. |
GetTemporaryGlueTableCredentialsResult |
getTemporaryGlueTableCredentials(GetTemporaryGlueTableCredentialsRequest getTemporaryGlueTableCredentialsRequest)
Allows a caller in a secure environment to assume a role with permission to access Amazon S3.
|
GetWorkUnitResultsResult |
getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest)
Returns the work units resulting from the query.
|
GetWorkUnitsResult |
getWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest)
Retrieves the work units generated by the
StartQueryPlanning operation. |
GrantPermissionsResult |
grantPermissions(GrantPermissionsRequest grantPermissionsRequest)
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 listDataCellsFilterRequest)
Lists all the data cell filters on a table.
|
ListLakeFormationOptInsResult |
listLakeFormationOptIns(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest)
Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
|
ListLFTagsResult |
listLFTags(ListLFTagsRequest listLFTagsRequest)
Lists LF-tags that the requester has permission to view.
|
ListPermissionsResult |
listPermissions(ListPermissionsRequest listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
ListResourcesResult |
listResources(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
ListTableStorageOptimizersResult |
listTableStorageOptimizers(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
|
ListTransactionsResult |
listTransactions(ListTransactionsRequest listTransactionsRequest)
Returns metadata about transactions and their status.
|
PutDataLakeSettingsResult |
putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
|
RegisterResourceResult |
registerResource(RegisterResourceRequest registerResourceRequest)
Registers the resource as managed by the Data Catalog.
|
RemoveLFTagsFromResourceResult |
removeLFTagsFromResource(RemoveLFTagsFromResourceRequest removeLFTagsFromResourceRequest)
Removes an LF-tag from the resource.
|
RevokePermissionsResult |
revokePermissions(RevokePermissionsRequest revokePermissionsRequest)
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 searchDatabasesByLFTagsRequest)
This operation allows a search on
DATABASE resources by TagCondition . |
SearchTablesByLFTagsResult |
searchTablesByLFTags(SearchTablesByLFTagsRequest searchTablesByLFTagsRequest)
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 startQueryPlanningRequest)
Submits a request to process a query statement.
|
StartTransactionResult |
startTransaction(StartTransactionRequest startTransactionRequest)
Starts a new transaction and returns its transaction ID.
|
UpdateDataCellsFilterResult |
updateDataCellsFilter(UpdateDataCellsFilterRequest updateDataCellsFilterRequest)
Updates a data cell filter.
|
UpdateLakeFormationIdentityCenterConfigurationResult |
updateLakeFormationIdentityCenterConfiguration(UpdateLakeFormationIdentityCenterConfigurationRequest updateLakeFormationIdentityCenterConfigurationRequest)
Updates the IAM Identity Center connection parameters.
|
UpdateLFTagResult |
updateLFTag(UpdateLFTagRequest updateLFTagRequest)
Updates the list of possible values for the specified LF-tag key.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
|
UpdateTableObjectsResult |
updateTableObjects(UpdateTableObjectsRequest updateTableObjectsRequest)
Updates the manifest of Amazon S3 objects that make up the specified governed table.
|
UpdateTableStorageOptimizerResult |
updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest updateTableStorageOptimizerRequest)
Updates the configuration of the storage optimizers for a table.
|
static final String ENDPOINT_PREFIX
AddLFTagsToResourceResult addLFTagsToResource(AddLFTagsToResourceRequest addLFTagsToResourceRequest)
Attaches one or more LF-tags to an existing resource.
addLFTagsToResourceRequest
- 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.AssumeDecoratedRoleWithSAMLResult assumeDecoratedRoleWithSAML(AssumeDecoratedRoleWithSAMLRequest assumeDecoratedRoleWithSAMLRequest)
Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.
This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which
is authorized via the virtual API GetDataAccess
. Therefore, all SAML roles that can be assumed via
AssumeDecoratedRoleWithSAML
must at a minimum include lakeformation:GetDataAccess
in
their role policies. A typical IAM policy attached to such a role would look as follows:
assumeDecoratedRoleWithSAMLRequest
- 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.BatchGrantPermissionsResult batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
batchGrantPermissionsRequest
- InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.BatchRevokePermissionsResult batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
batchRevokePermissionsRequest
- InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.CancelTransactionResult cancelTransaction(CancelTransactionRequest cancelTransactionRequest)
Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
cancelTransactionRequest
- 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.CommitTransactionResult commitTransaction(CommitTransactionRequest commitTransactionRequest)
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.
commitTransactionRequest
- 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.CreateDataCellsFilterResult createDataCellsFilter(CreateDataCellsFilterRequest createDataCellsFilterRequest)
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
createDataCellsFilterRequest
- 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.CreateLFTagResult createLFTag(CreateLFTagRequest createLFTagRequest)
Creates an LF-tag with the specified name and values.
createLFTagRequest
- 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.CreateLakeFormationIdentityCenterConfigurationResult createLakeFormationIdentityCenterConfiguration(CreateLakeFormationIdentityCenterConfigurationRequest createLakeFormationIdentityCenterConfigurationRequest)
Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
createLakeFormationIdentityCenterConfigurationRequest
- InvalidInputException
- The input provided was not valid.AlreadyExistsException
- A resource to be created or added already exists.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.CreateLakeFormationOptInResult createLakeFormationOptIn(CreateLakeFormationOptInRequest createLakeFormationOptInRequest)
Enforce Lake Formation permissions for the given databases, tables, and principals.
createLakeFormationOptInRequest
- 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.ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.DeleteDataCellsFilterResult deleteDataCellsFilter(DeleteDataCellsFilterRequest deleteDataCellsFilterRequest)
Deletes a data cell filter.
deleteDataCellsFilterRequest
- 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.DeleteLFTagResult deleteLFTag(DeleteLFTagRequest deleteLFTagRequest)
Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation
will throw an exception. When you delete an LF-tag, the LFTagPolicy
attached to the LF-tag becomes
invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag
will no longer be applied to the resource.
deleteLFTagRequest
- 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.DeleteLakeFormationIdentityCenterConfigurationResult deleteLakeFormationIdentityCenterConfiguration(DeleteLakeFormationIdentityCenterConfigurationRequest deleteLakeFormationIdentityCenterConfigurationRequest)
Deletes an IAM Identity Center connection with Lake Formation.
deleteLakeFormationIdentityCenterConfigurationRequest
- 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.ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.DeleteLakeFormationOptInResult deleteLakeFormationOptIn(DeleteLakeFormationOptInRequest deleteLakeFormationOptInRequest)
Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
deleteLakeFormationOptInRequest
- 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.ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.DeleteObjectsOnCancelResult deleteObjectsOnCancel(DeleteObjectsOnCancelRequest deleteObjectsOnCancelRequest)
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.
deleteObjectsOnCancelRequest
- 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.DeregisterResourceResult deregisterResource(DeregisterResourceRequest deregisterResourceRequest)
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.
deregisterResourceRequest
- 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.DescribeLakeFormationIdentityCenterConfigurationResult describeLakeFormationIdentityCenterConfiguration(DescribeLakeFormationIdentityCenterConfigurationRequest describeLakeFormationIdentityCenterConfigurationRequest)
Retrieves the instance ARN and application ARN for the connection.
describeLakeFormationIdentityCenterConfigurationRequest
- 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.DescribeResourceResult describeResource(DescribeResourceRequest describeResourceRequest)
Retrieves the current data access role for the given resource registered in Lake Formation.
describeResourceRequest
- 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.DescribeTransactionResult describeTransaction(DescribeTransactionRequest describeTransactionRequest)
Returns the details of a single transaction.
describeTransactionRequest
- 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.ExtendTransactionResult extendTransaction(ExtendTransactionRequest extendTransactionRequest)
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.
extendTransactionRequest
- 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.GetDataCellsFilterResult getDataCellsFilter(GetDataCellsFilterRequest getDataCellsFilterRequest)
Returns a data cells filter.
getDataCellsFilterRequest
- EntityNotFoundException
- A specified entity does not exist.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.GetDataLakePrincipalResult getDataLakePrincipal(GetDataLakePrincipalRequest getDataLakePrincipalRequest)
Returns the identity of the invoking principal.
getDataLakePrincipalRequest
- InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.AccessDeniedException
- Access to a resource was denied.GetDataLakeSettingsResult getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getDataLakeSettingsRequest
- InternalServiceException
- An internal service error occurred.InvalidInputException
- The input provided was not valid.EntityNotFoundException
- A specified entity does not exist.GetEffectivePermissionsForPathResult getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
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.
getEffectivePermissionsForPathRequest
- 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.GetLFTagResult getLFTag(GetLFTagRequest getLFTagRequest)
Returns an LF-tag definition.
getLFTagRequest
- 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.GetQueryStateResult getQueryState(GetQueryStateRequest getQueryStateRequest)
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
.
getQueryStateRequest
- InternalServiceException
- An internal service error occurred.InvalidInputException
- The input provided was not valid.AccessDeniedException
- Access to a resource was denied.GetQueryStatisticsResult getQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest)
Retrieves statistics on the planning and execution of a query.
getQueryStatisticsRequest
- 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.GetResourceLFTagsResult getResourceLFTags(GetResourceLFTagsRequest getResourceLFTagsRequest)
Returns the LF-tags applied to a resource.
getResourceLFTagsRequest
- 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.GetTableObjectsResult getTableObjects(GetTableObjectsRequest getTableObjectsRequest)
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.
getTableObjectsRequest
- 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.GetTemporaryGluePartitionCredentialsResult getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest getTemporaryGluePartitionCredentialsRequest)
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.
getTemporaryGluePartitionCredentialsRequest
- 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.GetTemporaryGlueTableCredentialsResult getTemporaryGlueTableCredentials(GetTemporaryGlueTableCredentialsRequest getTemporaryGlueTableCredentialsRequest)
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.
getTemporaryGlueTableCredentialsRequest
- 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.GetWorkUnitResultsResult getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest)
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
getWorkUnitResultsRequest
- 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.GetWorkUnitsResult getWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest)
Retrieves the work units generated by the StartQueryPlanning
operation.
getWorkUnitsRequest
- 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.GrantPermissionsResult grantPermissions(GrantPermissionsRequest grantPermissionsRequest)
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.
grantPermissionsRequest
- ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.EntityNotFoundException
- A specified entity does not exist.InvalidInputException
- The input provided was not valid.ListDataCellsFilterResult listDataCellsFilter(ListDataCellsFilterRequest listDataCellsFilterRequest)
Lists all the data cell filters on a table.
listDataCellsFilterRequest
- 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.ListLFTagsResult listLFTags(ListLFTagsRequest listLFTagsRequest)
Lists LF-tags that the requester has permission to view.
listLFTagsRequest
- 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.ListLakeFormationOptInsResult listLakeFormationOptIns(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest)
Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
listLakeFormationOptInsRequest
- 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.ListPermissionsResult listPermissions(ListPermissionsRequest listPermissionsRequest)
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.
listPermissionsRequest
- InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.InternalServiceException
- An internal service error occurred.ListResourcesResult listResources(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
listResourcesRequest
- InvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.ListTableStorageOptimizersResult listTableStorageOptimizers(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
listTableStorageOptimizersRequest
- 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.ListTransactionsResult listTransactions(ListTransactionsRequest listTransactionsRequest)
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.
listTransactionsRequest
- InvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.PutDataLakeSettingsResult putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest)
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.
putDataLakeSettingsRequest
- InternalServiceException
- An internal service error occurred.InvalidInputException
- The input provided was not valid.RegisterResourceResult registerResource(RegisterResourceRequest registerResourceRequest)
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
registerResourceRequest
- 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.RemoveLFTagsFromResourceResult removeLFTagsFromResource(RemoveLFTagsFromResourceRequest removeLFTagsFromResourceRequest)
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.
removeLFTagsFromResourceRequest
- 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.RevokePermissionsResult revokePermissions(RevokePermissionsRequest revokePermissionsRequest)
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
revokePermissionsRequest
- ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.EntityNotFoundException
- A specified entity does not exist.InvalidInputException
- The input provided was not valid.SearchDatabasesByLFTagsResult searchDatabasesByLFTags(SearchDatabasesByLFTagsRequest searchDatabasesByLFTagsRequest)
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.
searchDatabasesByLFTagsRequest
- 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.SearchTablesByLFTagsResult searchTablesByLFTags(SearchTablesByLFTagsRequest searchTablesByLFTagsRequest)
This operation allows a search on TABLE
resources by LFTag
s. 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 LFTag
s are valid to verify
whether the returned resources can be shared.
searchTablesByLFTagsRequest
- 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.StartQueryPlanningResult startQueryPlanning(StartQueryPlanningRequest startQueryPlanningRequest)
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.
startQueryPlanningRequest
- 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.StartTransactionResult startTransaction(StartTransactionRequest startTransactionRequest)
Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
startTransactionRequest
- InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.UpdateDataCellsFilterResult updateDataCellsFilter(UpdateDataCellsFilterRequest updateDataCellsFilterRequest)
Updates a data cell filter.
updateDataCellsFilterRequest
- ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.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.UpdateLFTagResult updateLFTag(UpdateLFTagRequest updateLFTagRequest)
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.
updateLFTagRequest
- 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.UpdateLakeFormationIdentityCenterConfigurationResult updateLakeFormationIdentityCenterConfiguration(UpdateLakeFormationIdentityCenterConfigurationRequest updateLakeFormationIdentityCenterConfigurationRequest)
Updates the IAM Identity Center connection parameters.
updateLakeFormationIdentityCenterConfigurationRequest
- 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.ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
updateResourceRequest
- 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.UpdateTableObjectsResult updateTableObjects(UpdateTableObjectsRequest updateTableObjectsRequest)
Updates the manifest of Amazon S3 objects that make up the specified governed table.
updateTableObjectsRequest
- 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.UpdateTableStorageOptimizerResult updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest updateTableStorageOptimizerRequest)
Updates the configuration of the storage optimizers for a table.
updateTableStorageOptimizerRequest
- 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 a request.
request
- The originally executed request.