@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSLakeFormationClient extends AmazonWebServiceClient implements AWSLakeFormation
Defines the public endpoint for the Lake Formation service.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddLFTagsToResourceResult |
addLFTagsToResource(AddLFTagsToResourceRequest request)
Attaches one or more LF-tags to an existing resource.
|
AssumeDecoratedRoleWithSAMLResult |
assumeDecoratedRoleWithSAML(AssumeDecoratedRoleWithSAMLRequest request)
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 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.
|
CreateLakeFormationIdentityCenterConfigurationResult |
createLakeFormationIdentityCenterConfiguration(CreateLakeFormationIdentityCenterConfigurationRequest request)
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 request)
Enforce Lake Formation permissions for the given databases, tables, and principals.
|
CreateLFTagResult |
createLFTag(CreateLFTagRequest request)
Creates an LF-tag with the specified name and values.
|
DeleteDataCellsFilterResult |
deleteDataCellsFilter(DeleteDataCellsFilterRequest request)
Deletes a data cell filter.
|
DeleteLakeFormationIdentityCenterConfigurationResult |
deleteLakeFormationIdentityCenterConfiguration(DeleteLakeFormationIdentityCenterConfigurationRequest request)
Deletes an IAM Identity Center connection with Lake Formation.
|
DeleteLakeFormationOptInResult |
deleteLakeFormationOptIn(DeleteLakeFormationOptInRequest request)
Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
|
DeleteLFTagResult |
deleteLFTag(DeleteLFTagRequest request)
Deletes the specified LF-tag given a 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.
|
DescribeLakeFormationIdentityCenterConfigurationResult |
describeLakeFormationIdentityCenterConfiguration(DescribeLakeFormationIdentityCenterConfigurationRequest request)
Retrieves the instance ARN and application ARN for the connection.
|
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.
|
GetDataCellsFilterResult |
getDataCellsFilter(GetDataCellsFilterRequest request)
Returns a data cells filter.
|
GetDataLakePrincipalResult |
getDataLakePrincipal(GetDataLakePrincipalRequest request)
Returns the identity of the invoking principal.
|
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.
|
ListLakeFormationOptInsResult |
listLakeFormationOptIns(ListLakeFormationOptInsRequest request)
Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
|
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.
|
UpdateDataCellsFilterResult |
updateDataCellsFilter(UpdateDataCellsFilterRequest request)
Updates a data cell filter.
|
UpdateLakeFormationIdentityCenterConfigurationResult |
updateLakeFormationIdentityCenterConfiguration(UpdateLakeFormationIdentityCenterConfigurationRequest request)
Updates the IAM Identity Center connection parameters.
|
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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSLakeFormationClientBuilder builder()
public AddLFTagsToResourceResult addLFTagsToResource(AddLFTagsToResourceRequest request)
Attaches one or more LF-tags to an existing resource.
addLFTagsToResource
in interface AWSLakeFormation
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.public AssumeDecoratedRoleWithSAMLResult assumeDecoratedRoleWithSAML(AssumeDecoratedRoleWithSAMLRequest request)
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:
assumeDecoratedRoleWithSAML
in interface AWSLakeFormation
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.public BatchGrantPermissionsResult batchGrantPermissions(BatchGrantPermissionsRequest request)
Batch operation to grant permissions to the principal.
batchGrantPermissions
in interface AWSLakeFormation
batchGrantPermissionsRequest
- InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.public BatchRevokePermissionsResult batchRevokePermissions(BatchRevokePermissionsRequest request)
Batch operation to revoke permissions from the principal.
batchRevokePermissions
in interface AWSLakeFormation
batchRevokePermissionsRequest
- InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.public CancelTransactionResult cancelTransaction(CancelTransactionRequest request)
Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
cancelTransaction
in interface AWSLakeFormation
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.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.
commitTransaction
in interface AWSLakeFormation
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.public CreateDataCellsFilterResult createDataCellsFilter(CreateDataCellsFilterRequest request)
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
createDataCellsFilter
in interface AWSLakeFormation
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.public CreateLFTagResult createLFTag(CreateLFTagRequest request)
Creates an LF-tag with the specified name and values.
createLFTag
in interface AWSLakeFormation
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.public CreateLakeFormationIdentityCenterConfigurationResult createLakeFormationIdentityCenterConfiguration(CreateLakeFormationIdentityCenterConfigurationRequest request)
Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
createLakeFormationIdentityCenterConfiguration
in interface AWSLakeFormation
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.public CreateLakeFormationOptInResult createLakeFormationOptIn(CreateLakeFormationOptInRequest request)
Enforce Lake Formation permissions for the given databases, tables, and principals.
createLakeFormationOptIn
in interface AWSLakeFormation
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.public DeleteDataCellsFilterResult deleteDataCellsFilter(DeleteDataCellsFilterRequest request)
Deletes a data cell filter.
deleteDataCellsFilter
in interface AWSLakeFormation
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.public DeleteLFTagResult deleteLFTag(DeleteLFTagRequest request)
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.
deleteLFTag
in interface AWSLakeFormation
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.public DeleteLakeFormationIdentityCenterConfigurationResult deleteLakeFormationIdentityCenterConfiguration(DeleteLakeFormationIdentityCenterConfigurationRequest request)
Deletes an IAM Identity Center connection with Lake Formation.
deleteLakeFormationIdentityCenterConfiguration
in interface AWSLakeFormation
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.public DeleteLakeFormationOptInResult deleteLakeFormationOptIn(DeleteLakeFormationOptInRequest request)
Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
deleteLakeFormationOptIn
in interface AWSLakeFormation
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.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.
deleteObjectsOnCancel
in interface AWSLakeFormation
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.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.
deregisterResource
in interface AWSLakeFormation
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.public DescribeLakeFormationIdentityCenterConfigurationResult describeLakeFormationIdentityCenterConfiguration(DescribeLakeFormationIdentityCenterConfigurationRequest request)
Retrieves the instance ARN and application ARN for the connection.
describeLakeFormationIdentityCenterConfiguration
in interface AWSLakeFormation
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.public DescribeResourceResult describeResource(DescribeResourceRequest request)
Retrieves the current data access role for the given resource registered in Lake Formation.
describeResource
in interface AWSLakeFormation
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.public DescribeTransactionResult describeTransaction(DescribeTransactionRequest request)
Returns the details of a single transaction.
describeTransaction
in interface AWSLakeFormation
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.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.
extendTransaction
in interface AWSLakeFormation
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.public GetDataCellsFilterResult getDataCellsFilter(GetDataCellsFilterRequest request)
Returns a data cells filter.
getDataCellsFilter
in interface AWSLakeFormation
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.public GetDataLakePrincipalResult getDataLakePrincipal(GetDataLakePrincipalRequest request)
Returns the identity of the invoking principal.
getDataLakePrincipal
in interface AWSLakeFormation
getDataLakePrincipalRequest
- InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.AccessDeniedException
- Access to a resource was denied.public GetDataLakeSettingsResult getDataLakeSettings(GetDataLakeSettingsRequest request)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getDataLakeSettings
in interface AWSLakeFormation
getDataLakeSettingsRequest
- InternalServiceException
- An internal service error occurred.InvalidInputException
- The input provided was not valid.EntityNotFoundException
- A specified entity does not exist.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.
getEffectivePermissionsForPath
in interface AWSLakeFormation
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.public GetLFTagResult getLFTag(GetLFTagRequest request)
Returns an LF-tag definition.
getLFTag
in interface AWSLakeFormation
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.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
.
getQueryState
in interface AWSLakeFormation
getQueryStateRequest
- InternalServiceException
- An internal service error occurred.InvalidInputException
- The input provided was not valid.AccessDeniedException
- Access to a resource was denied.public GetQueryStatisticsResult getQueryStatistics(GetQueryStatisticsRequest request)
Retrieves statistics on the planning and execution of a query.
getQueryStatistics
in interface AWSLakeFormation
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.public GetResourceLFTagsResult getResourceLFTags(GetResourceLFTagsRequest request)
Returns the LF-tags applied to a resource.
getResourceLFTags
in interface AWSLakeFormation
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.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.
getTableObjects
in interface AWSLakeFormation
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.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.
getTemporaryGluePartitionCredentials
in interface AWSLakeFormation
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.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.
getTemporaryGlueTableCredentials
in interface AWSLakeFormation
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.public GetWorkUnitResultsResult getWorkUnitResults(GetWorkUnitResultsRequest request)
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
getWorkUnitResults
in interface AWSLakeFormation
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.public GetWorkUnitsResult getWorkUnits(GetWorkUnitsRequest request)
Retrieves the work units generated by the StartQueryPlanning
operation.
getWorkUnits
in interface AWSLakeFormation
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.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.
grantPermissions
in interface AWSLakeFormation
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.public ListDataCellsFilterResult listDataCellsFilter(ListDataCellsFilterRequest request)
Lists all the data cell filters on a table.
listDataCellsFilter
in interface AWSLakeFormation
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.public ListLFTagsResult listLFTags(ListLFTagsRequest request)
Lists LF-tags that the requester has permission to view.
listLFTags
in interface AWSLakeFormation
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.public ListLakeFormationOptInsResult listLakeFormationOptIns(ListLakeFormationOptInsRequest request)
Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
listLakeFormationOptIns
in interface AWSLakeFormation
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.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.
listPermissions
in interface AWSLakeFormation
listPermissionsRequest
- InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.InternalServiceException
- An internal service error occurred.public ListResourcesResult listResources(ListResourcesRequest request)
Lists the resources registered to be managed by the Data Catalog.
listResources
in interface AWSLakeFormation
listResourcesRequest
- InvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.public ListTableStorageOptimizersResult listTableStorageOptimizers(ListTableStorageOptimizersRequest request)
Returns the configuration of all storage optimizers associated with a specified table.
listTableStorageOptimizers
in interface AWSLakeFormation
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.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.
listTransactions
in interface AWSLakeFormation
listTransactionsRequest
- InvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.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.
putDataLakeSettings
in interface AWSLakeFormation
putDataLakeSettingsRequest
- InternalServiceException
- An internal service error occurred.InvalidInputException
- The input provided was not valid.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
registerResource
in interface AWSLakeFormation
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.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.
removeLFTagsFromResource
in interface AWSLakeFormation
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.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.
revokePermissions
in interface AWSLakeFormation
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.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.
searchDatabasesByLFTags
in interface AWSLakeFormation
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.public SearchTablesByLFTagsResult searchTablesByLFTags(SearchTablesByLFTagsRequest request)
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.
searchTablesByLFTags
in interface AWSLakeFormation
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.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.
startQueryPlanning
in interface AWSLakeFormation
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.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.
startTransaction
in interface AWSLakeFormation
startTransactionRequest
- InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.public UpdateDataCellsFilterResult updateDataCellsFilter(UpdateDataCellsFilterRequest request)
Updates a data cell filter.
updateDataCellsFilter
in interface AWSLakeFormation
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.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.
updateLFTag
in interface AWSLakeFormation
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.public UpdateLakeFormationIdentityCenterConfigurationResult updateLakeFormationIdentityCenterConfiguration(UpdateLakeFormationIdentityCenterConfigurationRequest request)
Updates the IAM Identity Center connection parameters.
updateLakeFormationIdentityCenterConfiguration
in interface AWSLakeFormation
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.public UpdateResourceResult updateResource(UpdateResourceRequest request)
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
updateResource
in interface AWSLakeFormation
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.public UpdateTableObjectsResult updateTableObjects(UpdateTableObjectsRequest request)
Updates the manifest of Amazon S3 objects that make up the specified governed table.
updateTableObjects
in interface AWSLakeFormation
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.public UpdateTableStorageOptimizerResult updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest request)
Updates the configuration of the storage optimizers for a table.
updateTableStorageOptimizer
in interface AWSLakeFormation
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.public 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 the request.
getCachedResponseMetadata
in interface AWSLakeFormation
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSLakeFormation
shutdown
in class AmazonWebServiceClient