@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface LakeFormationClient extends SdkClient
builder() method.
Defines the public endpoint for the Lake Formation service.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AddLfTagsToResourceResponse |
addLFTagsToResource(AddLfTagsToResourceRequest addLfTagsToResourceRequest)
Attaches one or more LF-tags to an existing resource.
|
default AddLfTagsToResourceResponse |
addLFTagsToResource(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest)
Attaches one or more LF-tags to an existing resource.
|
default BatchGrantPermissionsResponse |
batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
|
default BatchGrantPermissionsResponse |
batchGrantPermissions(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
|
default BatchRevokePermissionsResponse |
batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
|
default BatchRevokePermissionsResponse |
batchRevokePermissions(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
|
static LakeFormationClientBuilder |
builder()
Create a builder that can be used to configure and create a
LakeFormationClient. |
default CancelTransactionResponse |
cancelTransaction(CancelTransactionRequest cancelTransactionRequest)
Attempts to cancel the specified transaction.
|
default CancelTransactionResponse |
cancelTransaction(Consumer<CancelTransactionRequest.Builder> cancelTransactionRequest)
Attempts to cancel the specified transaction.
|
default CommitTransactionResponse |
commitTransaction(CommitTransactionRequest commitTransactionRequest)
Attempts to commit the specified transaction.
|
default CommitTransactionResponse |
commitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest)
Attempts to commit the specified transaction.
|
static LakeFormationClient |
create()
Create a
LakeFormationClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateDataCellsFilterResponse |
createDataCellsFilter(Consumer<CreateDataCellsFilterRequest.Builder> createDataCellsFilterRequest)
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
|
default CreateDataCellsFilterResponse |
createDataCellsFilter(CreateDataCellsFilterRequest createDataCellsFilterRequest)
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
|
default CreateLfTagResponse |
createLFTag(Consumer<CreateLfTagRequest.Builder> createLfTagRequest)
Creates an LF-tag with the specified name and values.
|
default CreateLfTagResponse |
createLFTag(CreateLfTagRequest createLfTagRequest)
Creates an LF-tag with the specified name and values.
|
default DeleteDataCellsFilterResponse |
deleteDataCellsFilter(Consumer<DeleteDataCellsFilterRequest.Builder> deleteDataCellsFilterRequest)
Deletes a data cell filter.
|
default DeleteDataCellsFilterResponse |
deleteDataCellsFilter(DeleteDataCellsFilterRequest deleteDataCellsFilterRequest)
Deletes a data cell filter.
|
default DeleteLfTagResponse |
deleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest)
Deletes the specified LF-tag key name.
|
default DeleteLfTagResponse |
deleteLFTag(DeleteLfTagRequest deleteLfTagRequest)
Deletes the specified LF-tag key name.
|
default DeleteObjectsOnCancelResponse |
deleteObjectsOnCancel(Consumer<DeleteObjectsOnCancelRequest.Builder> 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.
|
default DeleteObjectsOnCancelResponse |
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.
|
default DeregisterResourceResponse |
deregisterResource(Consumer<DeregisterResourceRequest.Builder> deregisterResourceRequest)
Deregisters the resource as managed by the Data Catalog.
|
default DeregisterResourceResponse |
deregisterResource(DeregisterResourceRequest deregisterResourceRequest)
Deregisters the resource as managed by the Data Catalog.
|
default DescribeResourceResponse |
describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)
Retrieves the current data access role for the given resource registered in Lake Formation.
|
default DescribeResourceResponse |
describeResource(DescribeResourceRequest describeResourceRequest)
Retrieves the current data access role for the given resource registered in Lake Formation.
|
default DescribeTransactionResponse |
describeTransaction(Consumer<DescribeTransactionRequest.Builder> describeTransactionRequest)
Returns the details of a single transaction.
|
default DescribeTransactionResponse |
describeTransaction(DescribeTransactionRequest describeTransactionRequest)
Returns the details of a single transaction.
|
default ExtendTransactionResponse |
extendTransaction(Consumer<ExtendTransactionRequest.Builder> extendTransactionRequest)
Indicates to the service that the specified transaction is still active and should not be treated as idle and
aborted.
|
default ExtendTransactionResponse |
extendTransaction(ExtendTransactionRequest extendTransactionRequest)
Indicates to the service that the specified transaction is still active and should not be treated as idle and
aborted.
|
default GetDataLakeSettingsResponse |
getDataLakeSettings(Consumer<GetDataLakeSettingsRequest.Builder> getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
|
default GetDataLakeSettingsResponse |
getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
|
default GetEffectivePermissionsForPathResponse |
getEffectivePermissionsForPath(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
default GetEffectivePermissionsForPathResponse |
getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
default GetEffectivePermissionsForPathIterable |
getEffectivePermissionsForPathPaginator(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
default GetEffectivePermissionsForPathIterable |
getEffectivePermissionsForPathPaginator(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
default GetLfTagResponse |
getLFTag(Consumer<GetLfTagRequest.Builder> getLfTagRequest)
Returns an LF-tag definition.
|
default GetLfTagResponse |
getLFTag(GetLfTagRequest getLfTagRequest)
Returns an LF-tag definition.
|
default GetQueryStateResponse |
getQueryState(Consumer<GetQueryStateRequest.Builder> getQueryStateRequest)
Returns the state of a query previously submitted.
|
default GetQueryStateResponse |
getQueryState(GetQueryStateRequest getQueryStateRequest)
Returns the state of a query previously submitted.
|
default GetQueryStatisticsResponse |
getQueryStatistics(Consumer<GetQueryStatisticsRequest.Builder> getQueryStatisticsRequest)
Retrieves statistics on the planning and execution of a query.
|
default GetQueryStatisticsResponse |
getQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest)
Retrieves statistics on the planning and execution of a query.
|
default GetResourceLfTagsResponse |
getResourceLFTags(Consumer<GetResourceLfTagsRequest.Builder> getResourceLfTagsRequest)
Returns the LF-tags applied to a resource.
|
default GetResourceLfTagsResponse |
getResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest)
Returns the LF-tags applied to a resource.
|
default GetTableObjectsResponse |
getTableObjects(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table.
|
default GetTableObjectsResponse |
getTableObjects(GetTableObjectsRequest getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table.
|
default GetTableObjectsIterable |
getTableObjectsPaginator(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table.
|
default GetTableObjectsIterable |
getTableObjectsPaginator(GetTableObjectsRequest getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table.
|
default GetTemporaryGluePartitionCredentialsResponse |
getTemporaryGluePartitionCredentials(Consumer<GetTemporaryGluePartitionCredentialsRequest.Builder> getTemporaryGluePartitionCredentialsRequest)
This API is identical to
GetTemporaryTableCredentials except that this is used when the target Data
Catalog resource is of type Partition. |
default GetTemporaryGluePartitionCredentialsResponse |
getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest getTemporaryGluePartitionCredentialsRequest)
This API is identical to
GetTemporaryTableCredentials except that this is used when the target Data
Catalog resource is of type Partition. |
default GetTemporaryGlueTableCredentialsResponse |
getTemporaryGlueTableCredentials(Consumer<GetTemporaryGlueTableCredentialsRequest.Builder> getTemporaryGlueTableCredentialsRequest)
Allows a caller in a secure environment to assume a role with permission to access Amazon S3.
|
default GetTemporaryGlueTableCredentialsResponse |
getTemporaryGlueTableCredentials(GetTemporaryGlueTableCredentialsRequest getTemporaryGlueTableCredentialsRequest)
Allows a caller in a secure environment to assume a role with permission to access Amazon S3.
|
default ResponseInputStream<GetWorkUnitResultsResponse> |
getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest)
Returns the work units resulting from the query.
|
default GetWorkUnitResultsResponse |
getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest,
Path destinationPath)
Returns the work units resulting from the query.
|
default <ReturnT> ReturnT |
getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest,
ResponseTransformer<GetWorkUnitResultsResponse,ReturnT> responseTransformer)
Returns the work units resulting from the query.
|
default ResponseInputStream<GetWorkUnitResultsResponse> |
getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest)
Returns the work units resulting from the query.
|
default GetWorkUnitResultsResponse |
getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest,
Path destinationPath)
Returns the work units resulting from the query.
|
default <ReturnT> ReturnT |
getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest,
ResponseTransformer<GetWorkUnitResultsResponse,ReturnT> responseTransformer)
Returns the work units resulting from the query.
|
default ResponseBytes<GetWorkUnitResultsResponse> |
getWorkUnitResultsAsBytes(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest)
Returns the work units resulting from the query.
|
default ResponseBytes<GetWorkUnitResultsResponse> |
getWorkUnitResultsAsBytes(GetWorkUnitResultsRequest getWorkUnitResultsRequest)
Returns the work units resulting from the query.
|
default GetWorkUnitsResponse |
getWorkUnits(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest)
Retrieves the work units generated by the
StartQueryPlanning operation. |
default GetWorkUnitsResponse |
getWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest)
Retrieves the work units generated by the
StartQueryPlanning operation. |
default GetWorkUnitsIterable |
getWorkUnitsPaginator(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest)
Retrieves the work units generated by the
StartQueryPlanning operation. |
default GetWorkUnitsIterable |
getWorkUnitsPaginator(GetWorkUnitsRequest getWorkUnitsRequest)
Retrieves the work units generated by the
StartQueryPlanning operation. |
default GrantPermissionsResponse |
grantPermissions(Consumer<GrantPermissionsRequest.Builder> grantPermissionsRequest)
Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data
storage such as Amazon S3.
|
default GrantPermissionsResponse |
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.
|
default ListDataCellsFilterResponse |
listDataCellsFilter(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest)
Lists all the data cell filters on a table.
|
default ListDataCellsFilterResponse |
listDataCellsFilter(ListDataCellsFilterRequest listDataCellsFilterRequest)
Lists all the data cell filters on a table.
|
default ListDataCellsFilterIterable |
listDataCellsFilterPaginator(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest)
Lists all the data cell filters on a table.
|
default ListDataCellsFilterIterable |
listDataCellsFilterPaginator(ListDataCellsFilterRequest listDataCellsFilterRequest)
Lists all the data cell filters on a table.
|
default ListLfTagsResponse |
listLFTags(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
|
default ListLfTagsResponse |
listLFTags(ListLfTagsRequest listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
|
default ListLFTagsIterable |
listLFTagsPaginator(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
|
default ListLFTagsIterable |
listLFTagsPaginator(ListLfTagsRequest listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
|
default ListPermissionsResponse |
listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default ListPermissionsResponse |
listPermissions(ListPermissionsRequest listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default ListPermissionsIterable |
listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default ListPermissionsIterable |
listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default ListResourcesResponse |
listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default ListResourcesResponse |
listResources(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default ListResourcesIterable |
listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default ListResourcesIterable |
listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default ListTableStorageOptimizersResponse |
listTableStorageOptimizers(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
|
default ListTableStorageOptimizersResponse |
listTableStorageOptimizers(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
|
default ListTableStorageOptimizersIterable |
listTableStorageOptimizersPaginator(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
|
default ListTableStorageOptimizersIterable |
listTableStorageOptimizersPaginator(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
|
default ListTransactionsResponse |
listTransactions(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest)
Returns metadata about transactions and their status.
|
default ListTransactionsResponse |
listTransactions(ListTransactionsRequest listTransactionsRequest)
Returns metadata about transactions and their status.
|
default ListTransactionsIterable |
listTransactionsPaginator(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest)
Returns metadata about transactions and their status.
|
default ListTransactionsIterable |
listTransactionsPaginator(ListTransactionsRequest listTransactionsRequest)
Returns metadata about transactions and their status.
|
default PutDataLakeSettingsResponse |
putDataLakeSettings(Consumer<PutDataLakeSettingsRequest.Builder> putDataLakeSettingsRequest)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
|
default PutDataLakeSettingsResponse |
putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
|
default RegisterResourceResponse |
registerResource(Consumer<RegisterResourceRequest.Builder> registerResourceRequest)
Registers the resource as managed by the Data Catalog.
|
default RegisterResourceResponse |
registerResource(RegisterResourceRequest registerResourceRequest)
Registers the resource as managed by the Data Catalog.
|
default RemoveLfTagsFromResourceResponse |
removeLFTagsFromResource(Consumer<RemoveLfTagsFromResourceRequest.Builder> removeLfTagsFromResourceRequest)
Removes an LF-tag from the resource.
|
default RemoveLfTagsFromResourceResponse |
removeLFTagsFromResource(RemoveLfTagsFromResourceRequest removeLfTagsFromResourceRequest)
Removes an LF-tag from the resource.
|
default RevokePermissionsResponse |
revokePermissions(Consumer<RevokePermissionsRequest.Builder> revokePermissionsRequest)
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data
storage such as Amazon S3.
|
default RevokePermissionsResponse |
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.
|
default SearchDatabasesByLfTagsResponse |
searchDatabasesByLFTags(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest)
This operation allows a search on
DATABASE resources by TagCondition. |
default SearchDatabasesByLfTagsResponse |
searchDatabasesByLFTags(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest)
This operation allows a search on
DATABASE resources by TagCondition. |
default SearchDatabasesByLFTagsIterable |
searchDatabasesByLFTagsPaginator(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest)
This operation allows a search on
DATABASE resources by TagCondition. |
default SearchDatabasesByLFTagsIterable |
searchDatabasesByLFTagsPaginator(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest)
This operation allows a search on
DATABASE resources by TagCondition. |
default SearchTablesByLfTagsResponse |
searchTablesByLFTags(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest)
This operation allows a search on
TABLE resources by LFTags. |
default SearchTablesByLfTagsResponse |
searchTablesByLFTags(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest)
This operation allows a search on
TABLE resources by LFTags. |
default SearchTablesByLFTagsIterable |
searchTablesByLFTagsPaginator(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest)
This operation allows a search on
TABLE resources by LFTags. |
default SearchTablesByLFTagsIterable |
searchTablesByLFTagsPaginator(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest)
This operation allows a search on
TABLE resources by LFTags. |
static ServiceMetadata |
serviceMetadata() |
default StartQueryPlanningResponse |
startQueryPlanning(Consumer<StartQueryPlanningRequest.Builder> startQueryPlanningRequest)
Submits a request to process a query statement.
|
default StartQueryPlanningResponse |
startQueryPlanning(StartQueryPlanningRequest startQueryPlanningRequest)
Submits a request to process a query statement.
|
default StartTransactionResponse |
startTransaction(Consumer<StartTransactionRequest.Builder> startTransactionRequest)
Starts a new transaction and returns its transaction ID.
|
default StartTransactionResponse |
startTransaction(StartTransactionRequest startTransactionRequest)
Starts a new transaction and returns its transaction ID.
|
default UpdateLfTagResponse |
updateLFTag(Consumer<UpdateLfTagRequest.Builder> updateLfTagRequest)
Updates the list of possible values for the specified LF-tag key.
|
default UpdateLfTagResponse |
updateLFTag(UpdateLfTagRequest updateLfTagRequest)
Updates the list of possible values for the specified LF-tag key.
|
default UpdateResourceResponse |
updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
|
default UpdateResourceResponse |
updateResource(UpdateResourceRequest updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
|
default UpdateTableObjectsResponse |
updateTableObjects(Consumer<UpdateTableObjectsRequest.Builder> updateTableObjectsRequest)
Updates the manifest of Amazon S3 objects that make up the specified governed table.
|
default UpdateTableObjectsResponse |
updateTableObjects(UpdateTableObjectsRequest updateTableObjectsRequest)
Updates the manifest of Amazon S3 objects that make up the specified governed table.
|
default UpdateTableStorageOptimizerResponse |
updateTableStorageOptimizer(Consumer<UpdateTableStorageOptimizerRequest.Builder> updateTableStorageOptimizerRequest)
Updates the configuration of the storage optimizers for a table.
|
default UpdateTableStorageOptimizerResponse |
updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest updateTableStorageOptimizerRequest)
Updates the configuration of the storage optimizers for a table.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static LakeFormationClient create()
LakeFormationClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static LakeFormationClientBuilder builder()
LakeFormationClient.default AddLfTagsToResourceResponse addLFTagsToResource(AddLfTagsToResourceRequest addLfTagsToResourceRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
Attaches one or more LF-tags to an existing resource.
addLfTagsToResourceRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddLfTagsToResourceResponse addLFTagsToResource(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
Attaches one or more LF-tags to an existing resource.
This is a convenience which creates an instance of the AddLfTagsToResourceRequest.Builder avoiding the
need to create one manually via AddLfTagsToResourceRequest.builder()
addLfTagsToResourceRequest - A Consumer that will call methods on AddLFTagsToResourceRequest.Builder to create a
request.EntityNotFoundException - A specified entity does not existInvalidInputException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGrantPermissionsResponse batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Batch operation to grant permissions to the principal.
batchGrantPermissionsRequest - InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGrantPermissionsResponse batchGrantPermissions(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Batch operation to grant permissions to the principal.
This is a convenience which creates an instance of the BatchGrantPermissionsRequest.Builder avoiding the
need to create one manually via BatchGrantPermissionsRequest.builder()
batchGrantPermissionsRequest - A Consumer that will call methods on BatchGrantPermissionsRequest.Builder to create a
request.InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchRevokePermissionsResponse batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Batch operation to revoke permissions from the principal.
batchRevokePermissionsRequest - InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchRevokePermissionsResponse batchRevokePermissions(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Batch operation to revoke permissions from the principal.
This is a convenience which creates an instance of the BatchRevokePermissionsRequest.Builder avoiding the
need to create one manually via BatchRevokePermissionsRequest.builder()
batchRevokePermissionsRequest - A Consumer that will call methods on BatchRevokePermissionsRequest.Builder to create a
request.InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelTransactionResponse cancelTransaction(CancelTransactionRequest cancelTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCommittedException, TransactionCommitInProgressException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
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 existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelTransactionResponse cancelTransaction(Consumer<CancelTransactionRequest.Builder> cancelTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCommittedException, TransactionCommitInProgressException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
This is a convenience which creates an instance of the CancelTransactionRequest.Builder avoiding the need
to create one manually via CancelTransactionRequest.builder()
cancelTransactionRequest - A Consumer that will call methods on CancelTransactionRequest.Builder to create a request.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CommitTransactionResponse commitTransaction(CommitTransactionRequest commitTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCanceledException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
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 existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CommitTransactionResponse commitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCanceledException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the CommitTransactionRequest.Builder avoiding the need
to create one manually via CommitTransactionRequest.builder()
commitTransactionRequest - A Consumer that will call methods on CommitTransactionRequest.Builder to create a request.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDataCellsFilterResponse createDataCellsFilter(CreateDataCellsFilterRequest createDataCellsFilterRequest) throws AlreadyExistsException, InvalidInputException, EntityNotFoundException, ResourceNumberLimitExceededException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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 existResourceNumberLimitExceededException - A resource numerical limit was exceeded.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDataCellsFilterResponse createDataCellsFilter(Consumer<CreateDataCellsFilterRequest.Builder> createDataCellsFilterRequest) throws AlreadyExistsException, InvalidInputException, EntityNotFoundException, ResourceNumberLimitExceededException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
This is a convenience which creates an instance of the CreateDataCellsFilterRequest.Builder avoiding the
need to create one manually via CreateDataCellsFilterRequest.builder()
createDataCellsFilterRequest - A Consumer that will call methods on CreateDataCellsFilterRequest.Builder to create a
request.AlreadyExistsException - A resource to be created or added already exists.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existResourceNumberLimitExceededException - A resource numerical limit was exceeded.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLfTagResponse createLFTag(CreateLfTagRequest createLfTagRequest) throws EntityNotFoundException, InvalidInputException, ResourceNumberLimitExceededException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Creates an LF-tag with the specified name and values.
createLfTagRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLfTagResponse createLFTag(Consumer<CreateLfTagRequest.Builder> createLfTagRequest) throws EntityNotFoundException, InvalidInputException, ResourceNumberLimitExceededException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Creates an LF-tag with the specified name and values.
This is a convenience which creates an instance of the CreateLfTagRequest.Builder avoiding the need to
create one manually via CreateLfTagRequest.builder()
createLfTagRequest - A Consumer that will call methods on CreateLFTagRequest.Builder to create a request.EntityNotFoundException - A specified entity does not existInvalidInputException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDataCellsFilterResponse deleteDataCellsFilter(DeleteDataCellsFilterRequest deleteDataCellsFilterRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Deletes a data cell filter.
deleteDataCellsFilterRequest - InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existInternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDataCellsFilterResponse deleteDataCellsFilter(Consumer<DeleteDataCellsFilterRequest.Builder> deleteDataCellsFilterRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Deletes a data cell filter.
This is a convenience which creates an instance of the DeleteDataCellsFilterRequest.Builder avoiding the
need to create one manually via DeleteDataCellsFilterRequest.builder()
deleteDataCellsFilterRequest - A Consumer that will call methods on DeleteDataCellsFilterRequest.Builder to create a
request.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existInternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLfTagResponse deleteLFTag(DeleteLfTagRequest deleteLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Deletes the specified LF-tag key name. If the attribute key does not exist or the LF-tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message "Delete not allowed" as the LF-tag key is still attached with resources. You can consider untagging resources with this LF-tag key.
deleteLfTagRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLfTagResponse deleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Deletes the specified LF-tag key name. If the attribute key does not exist or the LF-tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message "Delete not allowed" as the LF-tag key is still attached with resources. You can consider untagging resources with this LF-tag key.
This is a convenience which creates an instance of the DeleteLfTagRequest.Builder avoiding the need to
create one manually via DeleteLfTagRequest.builder()
deleteLfTagRequest - A Consumer that will call methods on DeleteLFTagRequest.Builder to create a request.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteObjectsOnCancelResponse deleteObjectsOnCancel(DeleteObjectsOnCancelRequest deleteObjectsOnCancelRequest) throws InternalServiceException, InvalidInputException, OperationTimeoutException, EntityNotFoundException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
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 existTransactionCommittedException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteObjectsOnCancelResponse deleteObjectsOnCancel(Consumer<DeleteObjectsOnCancelRequest.Builder> deleteObjectsOnCancelRequest) throws InternalServiceException, InvalidInputException, OperationTimeoutException, EntityNotFoundException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the DeleteObjectsOnCancelRequest.Builder avoiding the
need to create one manually via DeleteObjectsOnCancelRequest.builder()
deleteObjectsOnCancelRequest - A Consumer that will call methods on DeleteObjectsOnCancelRequest.Builder to create a
request.InternalServiceException - An internal service error occurred.InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existTransactionCommittedException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterResourceResponse deregisterResource(DeregisterResourceRequest deregisterResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
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 existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterResourceResponse deregisterResource(Consumer<DeregisterResourceRequest.Builder> deregisterResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the DeregisterResourceRequest.Builder avoiding the
need to create one manually via DeregisterResourceRequest.builder()
deregisterResourceRequest - A Consumer that will call methods on DeregisterResourceRequest.Builder to create a
request.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeResourceResponse describeResource(DescribeResourceRequest describeResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
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 existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeResourceResponse describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Retrieves the current data access role for the given resource registered in Lake Formation.
This is a convenience which creates an instance of the DescribeResourceRequest.Builder avoiding the need
to create one manually via DescribeResourceRequest.builder()
describeResourceRequest - A Consumer that will call methods on DescribeResourceRequest.Builder to create a request.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTransactionResponse describeTransaction(DescribeTransactionRequest describeTransactionRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Returns the details of a single transaction.
describeTransactionRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTransactionResponse describeTransaction(Consumer<DescribeTransactionRequest.Builder> describeTransactionRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Returns the details of a single transaction.
This is a convenience which creates an instance of the DescribeTransactionRequest.Builder avoiding the
need to create one manually via DescribeTransactionRequest.builder()
describeTransactionRequest - A Consumer that will call methods on DescribeTransactionRequest.Builder to create a
request.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExtendTransactionResponse extendTransaction(ExtendTransactionRequest extendTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, TransactionCommitInProgressException, AwsServiceException, SdkClientException, LakeFormationException
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 existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExtendTransactionResponse extendTransaction(Consumer<ExtendTransactionRequest.Builder> extendTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, TransactionCommitInProgressException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the ExtendTransactionRequest.Builder avoiding the need
to create one manually via ExtendTransactionRequest.builder()
extendTransactionRequest - A Consumer that will call methods on ExtendTransactionRequest.Builder to create a request.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDataLakeSettingsResponse getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
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 existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDataLakeSettingsResponse getDataLakeSettings(Consumer<GetDataLakeSettingsRequest.Builder> getDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
This is a convenience which creates an instance of the GetDataLakeSettingsRequest.Builder avoiding the
need to create one manually via GetDataLakeSettingsRequest.builder()
getDataLakeSettingsRequest - A Consumer that will call methods on GetDataLakeSettingsRequest.Builder to create a
request.InternalServiceException - An internal service error occurred.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEffectivePermissionsForPathResponse getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
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 existOperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEffectivePermissionsForPathResponse getEffectivePermissionsForPath(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the GetEffectivePermissionsForPathRequest.Builder
avoiding the need to create one manually via GetEffectivePermissionsForPathRequest.builder()
getEffectivePermissionsForPathRequest - A Consumer that will call methods on GetEffectivePermissionsForPathRequest.Builder to
create a request.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existOperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEffectivePermissionsForPathIterable getEffectivePermissionsForPathPaginator(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a variant of
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client
.getEffectivePermissionsForPathPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation.
getEffectivePermissionsForPathRequest - InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existOperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEffectivePermissionsForPathIterable getEffectivePermissionsForPathPaginator(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a variant of
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client
.getEffectivePermissionsForPathPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation.
This is a convenience which creates an instance of the GetEffectivePermissionsForPathRequest.Builder
avoiding the need to create one manually via GetEffectivePermissionsForPathRequest.builder()
getEffectivePermissionsForPathRequest - A Consumer that will call methods on GetEffectivePermissionsForPathRequest.Builder to
create a request.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existOperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLfTagResponse getLFTag(GetLfTagRequest getLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Returns an LF-tag definition.
getLfTagRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLfTagResponse getLFTag(Consumer<GetLfTagRequest.Builder> getLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Returns an LF-tag definition.
This is a convenience which creates an instance of the GetLfTagRequest.Builder avoiding the need to
create one manually via GetLfTagRequest.builder()
getLfTagRequest - A Consumer that will call methods on GetLFTagRequest.Builder to create a request.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryStateResponse getQueryState(GetQueryStateRequest getQueryStateRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryStateResponse getQueryState(Consumer<GetQueryStateRequest.Builder> getQueryStateRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the GetQueryStateRequest.Builder avoiding the need to
create one manually via GetQueryStateRequest.builder()
getQueryStateRequest - A Consumer that will call methods on GetQueryStateRequest.Builder to create a request.InternalServiceException - An internal service error occurred.InvalidInputException - The input provided was not valid.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryStatisticsResponse getQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest) throws StatisticsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetQueryStatisticsResponse getQueryStatistics(Consumer<GetQueryStatisticsRequest.Builder> getQueryStatisticsRequest) throws StatisticsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
Retrieves statistics on the planning and execution of a query.
This is a convenience which creates an instance of the GetQueryStatisticsRequest.Builder avoiding the
need to create one manually via GetQueryStatisticsRequest.builder()
getQueryStatisticsRequest - A Consumer that will call methods on GetQueryStatisticsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetResourceLfTagsResponse getResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Returns the LF-tags applied to a resource.
getResourceLfTagsRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetResourceLfTagsResponse getResourceLFTags(Consumer<GetResourceLfTagsRequest.Builder> getResourceLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Returns the LF-tags applied to a resource.
This is a convenience which creates an instance of the GetResourceLfTagsRequest.Builder avoiding the need
to create one manually via GetResourceLfTagsRequest.builder()
getResourceLfTagsRequest - A Consumer that will call methods on GetResourceLFTagsRequest.Builder to create a request.EntityNotFoundException - A specified entity does not existInvalidInputException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTableObjectsResponse getTableObjects(GetTableObjectsRequest getTableObjectsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, AwsServiceException, SdkClientException, LakeFormationException
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 existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTableObjectsResponse getTableObjects(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the GetTableObjectsRequest.Builder avoiding the need
to create one manually via GetTableObjectsRequest.builder()
getTableObjectsRequest - A Consumer that will call methods on GetTableObjectsRequest.Builder to create a request.EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTableObjectsIterable getTableObjectsPaginator(GetTableObjectsRequest getTableObjectsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a variant of
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client.getTableObjectsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client
.getTableObjectsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client.getTableObjectsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)
operation.
getTableObjectsRequest - EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTableObjectsIterable getTableObjectsPaginator(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a variant of
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client.getTableObjectsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client
.getTableObjectsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client.getTableObjectsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)
operation.
This is a convenience which creates an instance of the GetTableObjectsRequest.Builder avoiding the need
to create one manually via GetTableObjectsRequest.builder()
getTableObjectsRequest - A Consumer that will call methods on GetTableObjectsRequest.Builder to create a request.EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTemporaryGluePartitionCredentialsResponse getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest getTemporaryGluePartitionCredentialsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, PermissionTypeMismatchException, AwsServiceException, SdkClientException, LakeFormationException
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 existAccessDeniedException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTemporaryGluePartitionCredentialsResponse getTemporaryGluePartitionCredentials(Consumer<GetTemporaryGluePartitionCredentialsRequest.Builder> getTemporaryGluePartitionCredentialsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, PermissionTypeMismatchException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the
GetTemporaryGluePartitionCredentialsRequest.Builder avoiding the need to create one manually via
GetTemporaryGluePartitionCredentialsRequest.builder()
getTemporaryGluePartitionCredentialsRequest - A Consumer that will call methods on GetTemporaryGluePartitionCredentialsRequest.Builder
to create a request.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existAccessDeniedException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTemporaryGlueTableCredentialsResponse getTemporaryGlueTableCredentials(GetTemporaryGlueTableCredentialsRequest getTemporaryGlueTableCredentialsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, PermissionTypeMismatchException, AwsServiceException, SdkClientException, LakeFormationException
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 existAccessDeniedException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTemporaryGlueTableCredentialsResponse getTemporaryGlueTableCredentials(Consumer<GetTemporaryGlueTableCredentialsRequest.Builder> getTemporaryGlueTableCredentialsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, PermissionTypeMismatchException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the GetTemporaryGlueTableCredentialsRequest.Builder
avoiding the need to create one manually via GetTemporaryGlueTableCredentialsRequest.builder()
getTemporaryGlueTableCredentialsRequest - A Consumer that will call methods on GetTemporaryGlueTableCredentialsRequest.Builder to
create a request.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existAccessDeniedException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, ResponseTransformer<GetWorkUnitResultsResponse,ReturnT> responseTransformer) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
getWorkUnitResultsRequest - responseTransformer - Functional interface for processing the streamed response content. The unmarshalled
GetWorkUnitResultsResponse and an InputStream to the response content are provided as parameters to the
callback. The callback may return a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows '
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, ResponseTransformer<GetWorkUnitResultsResponse,ReturnT> responseTransformer) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
This is a convenience which creates an instance of the GetWorkUnitResultsRequest.Builder avoiding the
need to create one manually via GetWorkUnitResultsRequest.builder()
getWorkUnitResultsRequest - A Consumer that will call methods on GetWorkUnitResultsRequest.Builder to create a
request.responseTransformer - Functional interface for processing the streamed response content. The unmarshalled
GetWorkUnitResultsResponse and an InputStream to the response content are provided as parameters to the
callback. The callback may return a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows '
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetWorkUnitResultsResponse getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, Path destinationPath) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
getWorkUnitResultsRequest - destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetWorkUnitResults(GetWorkUnitResultsRequest, ResponseTransformer),
AWS API Documentationdefault GetWorkUnitResultsResponse getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, Path destinationPath) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
This is a convenience which creates an instance of the GetWorkUnitResultsRequest.Builder avoiding the
need to create one manually via GetWorkUnitResultsRequest.builder()
getWorkUnitResultsRequest - A Consumer that will call methods on GetWorkUnitResultsRequest.Builder to create a
request.destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetWorkUnitResults(GetWorkUnitResultsRequest, ResponseTransformer),
AWS API Documentationdefault ResponseInputStream<GetWorkUnitResultsResponse> getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
getWorkUnitResultsRequest - ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getWorkUnitResults, ResponseTransformer),
AWS API Documentationdefault ResponseInputStream<GetWorkUnitResultsResponse> getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
This is a convenience which creates an instance of the GetWorkUnitResultsRequest.Builder avoiding the
need to create one manually via GetWorkUnitResultsRequest.builder()
getWorkUnitResultsRequest - A Consumer that will call methods on GetWorkUnitResultsRequest.Builder to create a
request.ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getWorkUnitResults, ResponseTransformer),
AWS API Documentationdefault ResponseBytes<GetWorkUnitResultsResponse> getWorkUnitResultsAsBytes(GetWorkUnitResultsRequest getWorkUnitResultsRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
getWorkUnitResultsRequest - ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows '
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getWorkUnitResults, ResponseTransformer),
AWS API Documentationdefault ResponseBytes<GetWorkUnitResultsResponse> getWorkUnitResultsAsBytes(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
This is a convenience which creates an instance of the GetWorkUnitResultsRequest.Builder avoiding the
need to create one manually via GetWorkUnitResultsRequest.builder()
getWorkUnitResultsRequest - A Consumer that will call methods on GetWorkUnitResultsRequest.Builder to create a
request.ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows '
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getWorkUnitResults, ResponseTransformer),
AWS API Documentationdefault GetWorkUnitsResponse getWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetWorkUnitsResponse getWorkUnits(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException
Retrieves the work units generated by the StartQueryPlanning operation.
This is a convenience which creates an instance of the GetWorkUnitsRequest.Builder avoiding the need to
create one manually via GetWorkUnitsRequest.builder()
getWorkUnitsRequest - A Consumer that will call methods on GetWorkUnitsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetWorkUnitsIterable getWorkUnitsPaginator(GetWorkUnitsRequest getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException
Retrieves the work units generated by the StartQueryPlanning operation.
This is a variant of
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client.getWorkUnitsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client
.getWorkUnitsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client.getWorkUnitsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest) 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetWorkUnitsIterable getWorkUnitsPaginator(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException
Retrieves the work units generated by the StartQueryPlanning operation.
This is a variant of
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client.getWorkUnitsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client
.getWorkUnitsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client.getWorkUnitsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest) operation.
This is a convenience which creates an instance of the GetWorkUnitsRequest.Builder avoiding the need to
create one manually via GetWorkUnitsRequest.builder()
getWorkUnitsRequest - A Consumer that will call methods on GetWorkUnitsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GrantPermissionsResponse grantPermissions(GrantPermissionsRequest grantPermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
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 existInvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GrantPermissionsResponse grantPermissions(Consumer<GrantPermissionsRequest.Builder> grantPermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the GrantPermissionsRequest.Builder avoiding the need
to create one manually via GrantPermissionsRequest.builder()
grantPermissionsRequest - A Consumer that will call methods on GrantPermissionsRequest.Builder to create a request.ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataCellsFilterResponse listDataCellsFilter(ListDataCellsFilterRequest listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataCellsFilterResponse listDataCellsFilter(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Lists all the data cell filters on a table.
This is a convenience which creates an instance of the ListDataCellsFilterRequest.Builder avoiding the
need to create one manually via ListDataCellsFilterRequest.builder()
listDataCellsFilterRequest - A Consumer that will call methods on ListDataCellsFilterRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataCellsFilterIterable listDataCellsFilterPaginator(ListDataCellsFilterRequest listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Lists all the data cell filters on a table.
This is a variant of
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client.listDataCellsFilterPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client
.listDataCellsFilterPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client.listDataCellsFilterPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)
operation.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDataCellsFilterIterable listDataCellsFilterPaginator(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Lists all the data cell filters on a table.
This is a variant of
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client.listDataCellsFilterPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client
.listDataCellsFilterPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client.listDataCellsFilterPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)
operation.
This is a convenience which creates an instance of the ListDataCellsFilterRequest.Builder avoiding the
need to create one manually via ListDataCellsFilterRequest.builder()
listDataCellsFilterRequest - A Consumer that will call methods on ListDataCellsFilterRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLfTagsResponse listLFTags(ListLfTagsRequest listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Lists LF-tags that the requester has permission to view.
listLfTagsRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLfTagsResponse listLFTags(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Lists LF-tags that the requester has permission to view.
This is a convenience which creates an instance of the ListLfTagsRequest.Builder avoiding the need to
create one manually via ListLfTagsRequest.builder()
listLfTagsRequest - A Consumer that will call methods on ListLFTagsRequest.Builder to create a request.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLFTagsIterable listLFTagsPaginator(ListLfTagsRequest listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Lists LF-tags that the requester has permission to view.
This is a variant of listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest) operation.
listLfTagsRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListLFTagsIterable listLFTagsPaginator(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
Lists LF-tags that the requester has permission to view.
This is a variant of listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest) operation.
This is a convenience which creates an instance of the ListLfTagsRequest.Builder avoiding the need to
create one manually via ListLfTagsRequest.builder()
listLfTagsRequest - A Consumer that will call methods on ListLFTagsRequest.Builder to create a request.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPermissionsResponse listPermissions(ListPermissionsRequest listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPermissionsResponse listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the ListPermissionsRequest.Builder avoiding the need
to create one manually via ListPermissionsRequest.builder()
listPermissionsRequest - A Consumer that will call methods on ListPermissionsRequest.Builder to create a request.InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPermissionsIterable listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a variant of
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client
.listPermissionsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)
operation.
listPermissionsRequest - InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPermissionsIterable listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a variant of
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client
.listPermissionsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)
operation.
This is a convenience which creates an instance of the ListPermissionsRequest.Builder avoiding the need
to create one manually via ListPermissionsRequest.builder()
listPermissionsRequest - A Consumer that will call methods on ListPermissionsRequest.Builder to create a request.InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Lists the resources registered to be managed by the Data Catalog.
This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Lists the resources registered to be managed by the Data Catalog.
This is a variant of
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client
.listResourcesPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation.
listResourcesRequest - InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Lists the resources registered to be managed by the Data Catalog.
This is a variant of
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client
.listResourcesPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation.
This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTableStorageOptimizersResponse listTableStorageOptimizers(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns the configuration of all storage optimizers associated with a specified table.
listTableStorageOptimizersRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.AccessDeniedException - Access to a resource was denied.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTableStorageOptimizersResponse listTableStorageOptimizers(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns the configuration of all storage optimizers associated with a specified table.
This is a convenience which creates an instance of the ListTableStorageOptimizersRequest.Builder avoiding
the need to create one manually via ListTableStorageOptimizersRequest.builder()
listTableStorageOptimizersRequest - A Consumer that will call methods on ListTableStorageOptimizersRequest.Builder to create a
request.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.AccessDeniedException - Access to a resource was denied.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTableStorageOptimizersIterable listTableStorageOptimizersPaginator(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns the configuration of all storage optimizers associated with a specified table.
This is a variant of
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client.listTableStorageOptimizersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client
.listTableStorageOptimizersPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client.listTableStorageOptimizersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)
operation.
listTableStorageOptimizersRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.AccessDeniedException - Access to a resource was denied.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTableStorageOptimizersIterable listTableStorageOptimizersPaginator(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns the configuration of all storage optimizers associated with a specified table.
This is a variant of
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client.listTableStorageOptimizersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client
.listTableStorageOptimizersPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client.listTableStorageOptimizersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)
operation.
This is a convenience which creates an instance of the ListTableStorageOptimizersRequest.Builder avoiding
the need to create one manually via ListTableStorageOptimizersRequest.builder()
listTableStorageOptimizersRequest - A Consumer that will call methods on ListTableStorageOptimizersRequest.Builder to create a
request.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.AccessDeniedException - Access to a resource was denied.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTransactionsResponse listTransactions(ListTransactionsRequest listTransactionsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTransactionsResponse listTransactions(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the ListTransactionsRequest.Builder avoiding the need
to create one manually via ListTransactionsRequest.builder()
listTransactionsRequest - A Consumer that will call methods on ListTransactionsRequest.Builder to create a request.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTransactionsIterable listTransactionsPaginator(ListTransactionsRequest listTransactionsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a variant of
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client.listTransactionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client
.listTransactionsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client.listTransactionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)
operation.
listTransactionsRequest - InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTransactionsIterable listTransactionsPaginator(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a variant of
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client.listTransactionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client
.listTransactionsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client.listTransactionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)
operation.
This is a convenience which creates an instance of the ListTransactionsRequest.Builder avoiding the need
to create one manually via ListTransactionsRequest.builder()
listTransactionsRequest - A Consumer that will call methods on ListTransactionsRequest.Builder to create a request.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDataLakeSettingsResponse putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDataLakeSettingsResponse putDataLakeSettings(Consumer<PutDataLakeSettingsRequest.Builder> putDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the PutDataLakeSettingsRequest.Builder avoiding the
need to create one manually via PutDataLakeSettingsRequest.builder()
putDataLakeSettingsRequest - A Consumer that will call methods on PutDataLakeSettingsRequest.Builder to create a
request.InternalServiceException - An internal service error occurred.InvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterResourceResponse registerResource(RegisterResourceRequest registerResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AlreadyExistsException, EntityNotFoundException, ResourceNumberLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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 existResourceNumberLimitExceededException - A resource numerical limit was exceeded.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterResourceResponse registerResource(Consumer<RegisterResourceRequest.Builder> registerResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AlreadyExistsException, EntityNotFoundException, ResourceNumberLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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
This is a convenience which creates an instance of the RegisterResourceRequest.Builder avoiding the need
to create one manually via RegisterResourceRequest.builder()
registerResourceRequest - A Consumer that will call methods on RegisterResourceRequest.Builder to create a request.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 existResourceNumberLimitExceededException - A resource numerical limit was exceeded.AccessDeniedException - Access to a resource was denied.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveLfTagsFromResourceResponse removeLFTagsFromResource(RemoveLfTagsFromResourceRequest removeLfTagsFromResourceRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
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 existInvalidInputException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveLfTagsFromResourceResponse removeLFTagsFromResource(Consumer<RemoveLfTagsFromResourceRequest.Builder> removeLfTagsFromResourceRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the RemoveLfTagsFromResourceRequest.Builder avoiding
the need to create one manually via RemoveLfTagsFromResourceRequest.builder()
removeLfTagsFromResourceRequest - A Consumer that will call methods on RemoveLFTagsFromResourceRequest.Builder to create a
request.EntityNotFoundException - A specified entity does not existInvalidInputException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RevokePermissionsResponse revokePermissions(RevokePermissionsRequest revokePermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
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 existInvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RevokePermissionsResponse revokePermissions(Consumer<RevokePermissionsRequest.Builder> revokePermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
This is a convenience which creates an instance of the RevokePermissionsRequest.Builder avoiding the need
to create one manually via RevokePermissionsRequest.builder()
revokePermissionsRequest - A Consumer that will call methods on RevokePermissionsRequest.Builder to create a request.ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchDatabasesByLfTagsResponse searchDatabasesByLFTags(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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 existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchDatabasesByLfTagsResponse searchDatabasesByLFTags(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the SearchDatabasesByLfTagsRequest.Builder avoiding
the need to create one manually via SearchDatabasesByLfTagsRequest.builder()
searchDatabasesByLfTagsRequest - A Consumer that will call methods on SearchDatabasesByLFTagsRequest.Builder to create a
request.EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchDatabasesByLFTagsIterable searchDatabasesByLFTagsPaginator(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a variant of
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client.searchDatabasesByLFTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client
.searchDatabasesByLFTagsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client.searchDatabasesByLFTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)
operation.
searchDatabasesByLfTagsRequest - EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchDatabasesByLFTagsIterable searchDatabasesByLFTagsPaginator(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a variant of
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client.searchDatabasesByLFTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client
.searchDatabasesByLFTagsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client.searchDatabasesByLFTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)
operation.
This is a convenience which creates an instance of the SearchDatabasesByLfTagsRequest.Builder avoiding
the need to create one manually via SearchDatabasesByLfTagsRequest.builder()
searchDatabasesByLfTagsRequest - A Consumer that will call methods on SearchDatabasesByLFTagsRequest.Builder to create a
request.EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchTablesByLfTagsResponse searchTablesByLFTags(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
This operation allows a search on TABLE resources by LFTags. This will be used by
admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use
SearchTablesByLFTags to find all resources where the given LFTags are valid to verify
whether the returned resources can be shared.
searchTablesByLfTagsRequest - EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchTablesByLfTagsResponse searchTablesByLFTags(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
This operation allows a search on TABLE resources by LFTags. This will be used by
admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use
SearchTablesByLFTags to find all resources where the given LFTags are valid to verify
whether the returned resources can be shared.
This is a convenience which creates an instance of the SearchTablesByLfTagsRequest.Builder avoiding the
need to create one manually via SearchTablesByLfTagsRequest.builder()
searchTablesByLfTagsRequest - A Consumer that will call methods on SearchTablesByLFTagsRequest.Builder to create a
request.EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchTablesByLFTagsIterable searchTablesByLFTagsPaginator(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
This operation allows a search on TABLE resources by LFTags. This will be used by
admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use
SearchTablesByLFTags to find all resources where the given LFTags are valid to verify
whether the returned resources can be shared.
This is a variant of
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client.searchTablesByLFTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client
.searchTablesByLFTagsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client.searchTablesByLFTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)
operation.
searchTablesByLfTagsRequest - EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SearchTablesByLFTagsIterable searchTablesByLFTagsPaginator(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
This operation allows a search on TABLE resources by LFTags. This will be used by
admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use
SearchTablesByLFTags to find all resources where the given LFTags are valid to verify
whether the returned resources can be shared.
This is a variant of
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client.searchTablesByLFTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client
.searchTablesByLFTagsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client.searchTablesByLFTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)
operation.
This is a convenience which creates an instance of the SearchTablesByLfTagsRequest.Builder avoiding the
need to create one manually via SearchTablesByLfTagsRequest.builder()
searchTablesByLfTagsRequest - A Consumer that will call methods on SearchTablesByLFTagsRequest.Builder to create a
request.EntityNotFoundException - A specified entity does not existInternalServiceException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartQueryPlanningResponse startQueryPlanning(StartQueryPlanningRequest startQueryPlanningRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartQueryPlanningResponse startQueryPlanning(Consumer<StartQueryPlanningRequest.Builder> startQueryPlanningRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the StartQueryPlanningRequest.Builder avoiding the
need to create one manually via StartQueryPlanningRequest.builder()
startQueryPlanningRequest - A Consumer that will call methods on StartQueryPlanningRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartTransactionResponse startTransaction(StartTransactionRequest startTransactionRequest) throws InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartTransactionResponse startTransaction(Consumer<StartTransactionRequest.Builder> startTransactionRequest) throws InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
This is a convenience which creates an instance of the StartTransactionRequest.Builder avoiding the need
to create one manually via StartTransactionRequest.builder()
startTransactionRequest - A Consumer that will call methods on StartTransactionRequest.Builder to create a request.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLfTagResponse updateLFTag(UpdateLfTagRequest updateLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, ConcurrentModificationException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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 existInvalidInputException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLfTagResponse updateLFTag(Consumer<UpdateLfTagRequest.Builder> updateLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, ConcurrentModificationException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException
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.
This is a convenience which creates an instance of the UpdateLfTagRequest.Builder avoiding the need to
create one manually via UpdateLfTagRequest.builder()
updateLfTagRequest - A Consumer that will call methods on UpdateLFTagRequest.Builder to create a request.EntityNotFoundException - A specified entity does not existInvalidInputException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
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 existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
This is a convenience which creates an instance of the UpdateResourceRequest.Builder avoiding the need to
create one manually via UpdateResourceRequest.builder()
updateResourceRequest - A Consumer that will call methods on UpdateResourceRequest.Builder to create a request.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTableObjectsResponse updateTableObjects(UpdateTableObjectsRequest updateTableObjectsRequest) throws InternalServiceException, InvalidInputException, OperationTimeoutException, EntityNotFoundException, TransactionCommittedException, TransactionCanceledException, TransactionCommitInProgressException, ResourceNotReadyException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
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 existTransactionCommittedException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTableObjectsResponse updateTableObjects(Consumer<UpdateTableObjectsRequest.Builder> updateTableObjectsRequest) throws InternalServiceException, InvalidInputException, OperationTimeoutException, EntityNotFoundException, TransactionCommittedException, TransactionCanceledException, TransactionCommitInProgressException, ResourceNotReadyException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException
Updates the manifest of Amazon S3 objects that make up the specified governed table.
This is a convenience which creates an instance of the UpdateTableObjectsRequest.Builder avoiding the
need to create one manually via UpdateTableObjectsRequest.builder()
updateTableObjectsRequest - A Consumer that will call methods on UpdateTableObjectsRequest.Builder to create a
request.InternalServiceException - An internal service error occurred.InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existTransactionCommittedException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTableStorageOptimizerResponse updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest updateTableStorageOptimizerRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Updates the configuration of the storage optimizers for a table.
updateTableStorageOptimizerRequest - EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.AccessDeniedException - Access to a resource was denied.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTableStorageOptimizerResponse updateTableStorageOptimizer(Consumer<UpdateTableStorageOptimizerRequest.Builder> updateTableStorageOptimizerRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Updates the configuration of the storage optimizers for a table.
This is a convenience which creates an instance of the UpdateTableStorageOptimizerRequest.Builder
avoiding the need to create one manually via UpdateTableStorageOptimizerRequest.builder()
updateTableStorageOptimizerRequest - A Consumer that will call methods on UpdateTableStorageOptimizerRequest.Builder to create
a request.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.AccessDeniedException - Access to a resource was denied.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.