Interface LakeFormationClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Defines the public endpoint for the Lake Formation service.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AddLfTagsToResourceResponse
addLFTagsToResource
(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest) Attaches one or more LF-tags to an existing resource.default AddLfTagsToResourceResponse
addLFTagsToResource
(AddLfTagsToResourceRequest addLfTagsToResourceRequest) Attaches one or more LF-tags to an existing resource.assumeDecoratedRoleWithSAML
(Consumer<AssumeDecoratedRoleWithSamlRequest.Builder> assumeDecoratedRoleWithSamlRequest) Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request.assumeDecoratedRoleWithSAML
(AssumeDecoratedRoleWithSamlRequest assumeDecoratedRoleWithSamlRequest) Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request.default BatchGrantPermissionsResponse
batchGrantPermissions
(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest) Batch operation to grant permissions to the principal.default BatchGrantPermissionsResponse
batchGrantPermissions
(BatchGrantPermissionsRequest batchGrantPermissionsRequest) Batch operation to grant permissions to the principal.default BatchRevokePermissionsResponse
batchRevokePermissions
(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest) Batch operation to revoke permissions from the principal.default BatchRevokePermissionsResponse
batchRevokePermissions
(BatchRevokePermissionsRequest batchRevokePermissionsRequest) Batch operation to revoke permissions from the principal.static LakeFormationClientBuilder
builder()
Create a builder that can be used to configure and create aLakeFormationClient
.default CancelTransactionResponse
cancelTransaction
(Consumer<CancelTransactionRequest.Builder> cancelTransactionRequest) Attempts to cancel the specified transaction.default CancelTransactionResponse
cancelTransaction
(CancelTransactionRequest cancelTransactionRequest) Attempts to cancel the specified transaction.default CommitTransactionResponse
commitTransaction
(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest) Attempts to commit the specified transaction.default CommitTransactionResponse
commitTransaction
(CommitTransactionRequest commitTransactionRequest) Attempts to commit the specified transaction.static LakeFormationClient
create()
Create aLakeFormationClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.createLakeFormationIdentityCenterConfiguration
(Consumer<CreateLakeFormationIdentityCenterConfigurationRequest.Builder> createLakeFormationIdentityCenterConfigurationRequest) Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.createLakeFormationIdentityCenterConfiguration
(CreateLakeFormationIdentityCenterConfigurationRequest createLakeFormationIdentityCenterConfigurationRequest) Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.default CreateLakeFormationOptInResponse
createLakeFormationOptIn
(Consumer<CreateLakeFormationOptInRequest.Builder> createLakeFormationOptInRequest) Enforce Lake Formation permissions for the given databases, tables, and principals.default CreateLakeFormationOptInResponse
createLakeFormationOptIn
(CreateLakeFormationOptInRequest createLakeFormationOptInRequest) Enforce Lake Formation permissions for the given databases, tables, and principals.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.deleteLakeFormationIdentityCenterConfiguration
(Consumer<DeleteLakeFormationIdentityCenterConfigurationRequest.Builder> deleteLakeFormationIdentityCenterConfigurationRequest) Deletes an IAM Identity Center connection with Lake Formation.deleteLakeFormationIdentityCenterConfiguration
(DeleteLakeFormationIdentityCenterConfigurationRequest deleteLakeFormationIdentityCenterConfigurationRequest) Deletes an IAM Identity Center connection with Lake Formation.default DeleteLakeFormationOptInResponse
deleteLakeFormationOptIn
(Consumer<DeleteLakeFormationOptInRequest.Builder> deleteLakeFormationOptInRequest) Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.default DeleteLakeFormationOptInResponse
deleteLakeFormationOptIn
(DeleteLakeFormationOptInRequest deleteLakeFormationOptInRequest) Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.default DeleteLfTagResponse
deleteLFTag
(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest) Deletes the specified LF-tag given a key name.default DeleteLfTagResponse
deleteLFTag
(DeleteLfTagRequest deleteLfTagRequest) Deletes the specified LF-tag given a 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.describeLakeFormationIdentityCenterConfiguration
(Consumer<DescribeLakeFormationIdentityCenterConfigurationRequest.Builder> describeLakeFormationIdentityCenterConfigurationRequest) Retrieves the instance ARN and application ARN for the connection.describeLakeFormationIdentityCenterConfiguration
(DescribeLakeFormationIdentityCenterConfigurationRequest describeLakeFormationIdentityCenterConfigurationRequest) Retrieves the instance ARN and application ARN for the connection.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 GetDataCellsFilterResponse
getDataCellsFilter
(Consumer<GetDataCellsFilterRequest.Builder> getDataCellsFilterRequest) Returns a data cells filter.default GetDataCellsFilterResponse
getDataCellsFilter
(GetDataCellsFilterRequest getDataCellsFilterRequest) Returns a data cells filter.default GetDataLakePrincipalResponse
getDataLakePrincipal
(Consumer<GetDataLakePrincipalRequest.Builder> getDataLakePrincipalRequest) Returns the identity of the invoking principal.default GetDataLakePrincipalResponse
getDataLakePrincipal
(GetDataLakePrincipalRequest getDataLakePrincipalRequest) Returns the identity of the invoking principal.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.getEffectivePermissionsForPath
(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.getEffectivePermissionsForPath
(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.getEffectivePermissionsForPathPaginator
(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) This is a variant ofgetEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation.getEffectivePermissionsForPathPaginator
(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) This is a variant ofgetEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation.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) This is a variant ofgetTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)
operation.default GetTableObjectsIterable
getTableObjectsPaginator
(GetTableObjectsRequest getTableObjectsRequest) This is a variant ofgetTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)
operation.getTemporaryGluePartitionCredentials
(Consumer<GetTemporaryGluePartitionCredentialsRequest.Builder> getTemporaryGluePartitionCredentialsRequest) This API is identical toGetTemporaryTableCredentials
except that this is used when the target Data Catalog resource is of type Partition.getTemporaryGluePartitionCredentials
(GetTemporaryGluePartitionCredentialsRequest getTemporaryGluePartitionCredentialsRequest) This API is identical toGetTemporaryTableCredentials
except that this is used when the target Data Catalog resource is of type Partition.getTemporaryGlueTableCredentials
(Consumer<GetTemporaryGlueTableCredentialsRequest.Builder> getTemporaryGlueTableCredentialsRequest) Allows a caller in a secure environment to assume a role with permission to access Amazon S3.getTemporaryGlueTableCredentials
(GetTemporaryGlueTableCredentialsRequest getTemporaryGlueTableCredentialsRequest) Allows a caller in a secure environment to assume a role with permission to access Amazon S3.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.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 theStartQueryPlanning
operation.default GetWorkUnitsResponse
getWorkUnits
(GetWorkUnitsRequest getWorkUnitsRequest) Retrieves the work units generated by theStartQueryPlanning
operation.default GetWorkUnitsIterable
getWorkUnitsPaginator
(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) This is a variant ofgetWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)
operation.default GetWorkUnitsIterable
getWorkUnitsPaginator
(GetWorkUnitsRequest getWorkUnitsRequest) This is a variant ofgetWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)
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) This is a variant oflistDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)
operation.default ListDataCellsFilterIterable
listDataCellsFilterPaginator
(ListDataCellsFilterRequest listDataCellsFilterRequest) This is a variant oflistDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)
operation.default ListLakeFormationOptInsResponse
listLakeFormationOptIns
(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.default ListLakeFormationOptInsResponse
listLakeFormationOptIns
(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.default ListLakeFormationOptInsIterable
listLakeFormationOptInsPaginator
(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) This is a variant oflistLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)
operation.default ListLakeFormationOptInsIterable
listLakeFormationOptInsPaginator
(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) This is a variant oflistLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)
operation.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) This is a variant oflistLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)
operation.default ListLFTagsIterable
listLFTagsPaginator
(ListLfTagsRequest listLfTagsRequest) This is a variant oflistLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)
operation.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) This is a variant oflistPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)
operation.default ListPermissionsIterable
listPermissionsPaginator
(ListPermissionsRequest listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)
operation.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) This is a variant oflistResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)
operation.default ListResourcesIterable
listResourcesPaginator
(ListResourcesRequest listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)
operation.listTableStorageOptimizers
(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) Returns the configuration of all storage optimizers associated with a specified table.listTableStorageOptimizers
(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) Returns the configuration of all storage optimizers associated with a specified table.listTableStorageOptimizersPaginator
(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) This is a variant oflistTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)
operation.listTableStorageOptimizersPaginator
(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) This is a variant oflistTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)
operation.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) This is a variant oflistTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)
operation.default ListTransactionsIterable
listTransactionsPaginator
(ListTransactionsRequest listTransactionsRequest) This is a variant oflistTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)
operation.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 onDATABASE
resources byTagCondition
.default SearchDatabasesByLfTagsResponse
searchDatabasesByLFTags
(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) This operation allows a search onDATABASE
resources byTagCondition
.default SearchDatabasesByLFTagsIterable
searchDatabasesByLFTagsPaginator
(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) This is a variant ofsearchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)
operation.default SearchDatabasesByLFTagsIterable
searchDatabasesByLFTagsPaginator
(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) This is a variant ofsearchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)
operation.default SearchTablesByLfTagsResponse
searchTablesByLFTags
(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) This operation allows a search onTABLE
resources byLFTag
s.default SearchTablesByLfTagsResponse
searchTablesByLFTags
(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) This operation allows a search onTABLE
resources byLFTag
s.default SearchTablesByLFTagsIterable
searchTablesByLFTagsPaginator
(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) This is a variant ofsearchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)
operation.default SearchTablesByLFTagsIterable
searchTablesByLFTagsPaginator
(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) This is a variant ofsearchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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 UpdateDataCellsFilterResponse
updateDataCellsFilter
(Consumer<UpdateDataCellsFilterRequest.Builder> updateDataCellsFilterRequest) Updates a data cell filter.default UpdateDataCellsFilterResponse
updateDataCellsFilter
(UpdateDataCellsFilterRequest updateDataCellsFilterRequest) Updates a data cell filter.updateLakeFormationIdentityCenterConfiguration
(Consumer<UpdateLakeFormationIdentityCenterConfigurationRequest.Builder> updateLakeFormationIdentityCenterConfigurationRequest) Updates the IAM Identity Center connection parameters.updateLakeFormationIdentityCenterConfiguration
(UpdateLakeFormationIdentityCenterConfigurationRequest updateLakeFormationIdentityCenterConfigurationRequest) Updates the IAM Identity Center connection parameters.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.updateTableStorageOptimizer
(Consumer<UpdateTableStorageOptimizerRequest.Builder> updateTableStorageOptimizerRequest) Updates the configuration of the storage optimizers for a table.updateTableStorageOptimizer
(UpdateTableStorageOptimizerRequest updateTableStorageOptimizerRequest) Updates the configuration of the storage optimizers for a table.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addLFTagsToResource
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.
- Parameters:
addLfTagsToResourceRequest
-- Returns:
- Result of the AddLFTagsToResource operation returned by the service.
- See Also:
-
addLFTagsToResource
default 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 viaAddLfTagsToResourceRequest.builder()
- Parameters:
addLfTagsToResourceRequest
- AConsumer
that will call methods onAddLfTagsToResourceRequest.Builder
to create a request.- Returns:
- Result of the AddLFTagsToResource operation returned by the service.
- See Also:
-
assumeDecoratedRoleWithSAML
default AssumeDecoratedRoleWithSamlResponse assumeDecoratedRoleWithSAML(AssumeDecoratedRoleWithSamlRequest assumeDecoratedRoleWithSamlRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.
This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API
GetDataAccess
. Therefore, all SAML roles that can be assumed viaAssumeDecoratedRoleWithSAML
must at a minimum includelakeformation:GetDataAccess
in their role policies. A typical IAM policy attached to such a role would look as follows:- Parameters:
assumeDecoratedRoleWithSamlRequest
-- Returns:
- Result of the AssumeDecoratedRoleWithSAML operation returned by the service.
- See Also:
-
assumeDecoratedRoleWithSAML
default AssumeDecoratedRoleWithSamlResponse assumeDecoratedRoleWithSAML(Consumer<AssumeDecoratedRoleWithSamlRequest.Builder> assumeDecoratedRoleWithSamlRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.
This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API
GetDataAccess
. Therefore, all SAML roles that can be assumed viaAssumeDecoratedRoleWithSAML
must at a minimum includelakeformation:GetDataAccess
in their role policies. A typical IAM policy attached to such a role would look as follows:
This is a convenience which creates an instance of the
AssumeDecoratedRoleWithSamlRequest.Builder
avoiding the need to create one manually viaAssumeDecoratedRoleWithSamlRequest.builder()
- Parameters:
assumeDecoratedRoleWithSamlRequest
- AConsumer
that will call methods onAssumeDecoratedRoleWithSamlRequest.Builder
to create a request.- Returns:
- Result of the AssumeDecoratedRoleWithSAML operation returned by the service.
- See Also:
-
batchGrantPermissions
default BatchGrantPermissionsResponse batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Batch operation to grant permissions to the principal.
- Parameters:
batchGrantPermissionsRequest
-- Returns:
- Result of the BatchGrantPermissions operation returned by the service.
- See Also:
-
batchGrantPermissions
default 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 viaBatchGrantPermissionsRequest.builder()
- Parameters:
batchGrantPermissionsRequest
- AConsumer
that will call methods onBatchGrantPermissionsRequest.Builder
to create a request.- Returns:
- Result of the BatchGrantPermissions operation returned by the service.
- See Also:
-
batchRevokePermissions
default BatchRevokePermissionsResponse batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Batch operation to revoke permissions from the principal.
- Parameters:
batchRevokePermissionsRequest
-- Returns:
- Result of the BatchRevokePermissions operation returned by the service.
- See Also:
-
batchRevokePermissions
default 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 viaBatchRevokePermissionsRequest.builder()
- Parameters:
batchRevokePermissionsRequest
- AConsumer
that will call methods onBatchRevokePermissionsRequest.Builder
to create a request.- Returns:
- Result of the BatchRevokePermissions operation returned by the service.
- See Also:
-
cancelTransaction
default 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.
- Parameters:
cancelTransactionRequest
-- Returns:
- Result of the CancelTransaction operation returned by the service.
- See Also:
-
cancelTransaction
default 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 viaCancelTransactionRequest.builder()
- Parameters:
cancelTransactionRequest
- AConsumer
that will call methods onCancelTransactionRequest.Builder
to create a request.- Returns:
- Result of the CancelTransaction operation returned by the service.
- See Also:
-
commitTransaction
default 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.
- Parameters:
commitTransactionRequest
-- Returns:
- Result of the CommitTransaction operation returned by the service.
- See Also:
-
commitTransaction
default 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 viaCommitTransactionRequest.builder()
- Parameters:
commitTransactionRequest
- AConsumer
that will call methods onCommitTransactionRequest.Builder
to create a request.- Returns:
- Result of the CommitTransaction operation returned by the service.
- See Also:
-
createDataCellsFilter
default 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.
- Parameters:
createDataCellsFilterRequest
-- Returns:
- Result of the CreateDataCellsFilter operation returned by the service.
- See Also:
-
createDataCellsFilter
default 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 viaCreateDataCellsFilterRequest.builder()
- Parameters:
createDataCellsFilterRequest
- AConsumer
that will call methods onCreateDataCellsFilterRequest.Builder
to create a request.- Returns:
- Result of the CreateDataCellsFilter operation returned by the service.
- See Also:
-
createLFTag
default CreateLfTagResponse createLFTag(CreateLfTagRequest createLfTagRequest) throws EntityNotFoundException, InvalidInputException, ResourceNumberLimitExceededException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Creates an LF-tag with the specified name and values.
- Parameters:
createLfTagRequest
-- Returns:
- Result of the CreateLFTag operation returned by the service.
- See Also:
-
createLFTag
default 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 viaCreateLfTagRequest.builder()
- Parameters:
createLfTagRequest
- AConsumer
that will call methods onCreateLfTagRequest.Builder
to create a request.- Returns:
- Result of the CreateLFTag operation returned by the service.
- See Also:
-
createLakeFormationIdentityCenterConfiguration
default CreateLakeFormationIdentityCenterConfigurationResponse createLakeFormationIdentityCenterConfiguration(CreateLakeFormationIdentityCenterConfigurationRequest createLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, AlreadyExistsException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
- Parameters:
createLakeFormationIdentityCenterConfigurationRequest
-- Returns:
- Result of the CreateLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
createLakeFormationIdentityCenterConfiguration
default CreateLakeFormationIdentityCenterConfigurationResponse createLakeFormationIdentityCenterConfiguration(Consumer<CreateLakeFormationIdentityCenterConfigurationRequest.Builder> createLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, AlreadyExistsException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
This is a convenience which creates an instance of the
CreateLakeFormationIdentityCenterConfigurationRequest.Builder
avoiding the need to create one manually viaCreateLakeFormationIdentityCenterConfigurationRequest.builder()
- Parameters:
createLakeFormationIdentityCenterConfigurationRequest
- AConsumer
that will call methods onCreateLakeFormationIdentityCenterConfigurationRequest.Builder
to create a request.- Returns:
- Result of the CreateLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
createLakeFormationOptIn
default CreateLakeFormationOptInResponse createLakeFormationOptIn(CreateLakeFormationOptInRequest createLakeFormationOptInRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Enforce Lake Formation permissions for the given databases, tables, and principals.
- Parameters:
createLakeFormationOptInRequest
-- Returns:
- Result of the CreateLakeFormationOptIn operation returned by the service.
- See Also:
-
createLakeFormationOptIn
default CreateLakeFormationOptInResponse createLakeFormationOptIn(Consumer<CreateLakeFormationOptInRequest.Builder> createLakeFormationOptInRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Enforce Lake Formation permissions for the given databases, tables, and principals.
This is a convenience which creates an instance of the
CreateLakeFormationOptInRequest.Builder
avoiding the need to create one manually viaCreateLakeFormationOptInRequest.builder()
- Parameters:
createLakeFormationOptInRequest
- AConsumer
that will call methods onCreateLakeFormationOptInRequest.Builder
to create a request.- Returns:
- Result of the CreateLakeFormationOptIn operation returned by the service.
- See Also:
-
deleteDataCellsFilter
default DeleteDataCellsFilterResponse deleteDataCellsFilter(DeleteDataCellsFilterRequest deleteDataCellsFilterRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Deletes a data cell filter.
- Parameters:
deleteDataCellsFilterRequest
-- Returns:
- Result of the DeleteDataCellsFilter operation returned by the service.
- See Also:
-
deleteDataCellsFilter
default 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 viaDeleteDataCellsFilterRequest.builder()
- Parameters:
deleteDataCellsFilterRequest
- AConsumer
that will call methods onDeleteDataCellsFilterRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataCellsFilter operation returned by the service.
- See Also:
-
deleteLFTag
default DeleteLfTagResponse deleteLFTag(DeleteLfTagRequest deleteLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the
LFTagPolicy
attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be applied to the resource.- Parameters:
deleteLfTagRequest
-- Returns:
- Result of the DeleteLFTag operation returned by the service.
- See Also:
-
deleteLFTag
default DeleteLfTagResponse deleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the
LFTagPolicy
attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag will no longer be applied to the resource.
This is a convenience which creates an instance of the
DeleteLfTagRequest.Builder
avoiding the need to create one manually viaDeleteLfTagRequest.builder()
- Parameters:
deleteLfTagRequest
- AConsumer
that will call methods onDeleteLfTagRequest.Builder
to create a request.- Returns:
- Result of the DeleteLFTag operation returned by the service.
- See Also:
-
deleteLakeFormationIdentityCenterConfiguration
default DeleteLakeFormationIdentityCenterConfigurationResponse deleteLakeFormationIdentityCenterConfiguration(DeleteLakeFormationIdentityCenterConfigurationRequest deleteLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Deletes an IAM Identity Center connection with Lake Formation.
- Parameters:
deleteLakeFormationIdentityCenterConfigurationRequest
-- Returns:
- Result of the DeleteLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
deleteLakeFormationIdentityCenterConfiguration
default DeleteLakeFormationIdentityCenterConfigurationResponse deleteLakeFormationIdentityCenterConfiguration(Consumer<DeleteLakeFormationIdentityCenterConfigurationRequest.Builder> deleteLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Deletes an IAM Identity Center connection with Lake Formation.
This is a convenience which creates an instance of the
DeleteLakeFormationIdentityCenterConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteLakeFormationIdentityCenterConfigurationRequest.builder()
- Parameters:
deleteLakeFormationIdentityCenterConfigurationRequest
- AConsumer
that will call methods onDeleteLakeFormationIdentityCenterConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DeleteLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
deleteLakeFormationOptIn
default DeleteLakeFormationOptInResponse deleteLakeFormationOptIn(DeleteLakeFormationOptInRequest deleteLakeFormationOptInRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
- Parameters:
deleteLakeFormationOptInRequest
-- Returns:
- Result of the DeleteLakeFormationOptIn operation returned by the service.
- See Also:
-
deleteLakeFormationOptIn
default DeleteLakeFormationOptInResponse deleteLakeFormationOptIn(Consumer<DeleteLakeFormationOptInRequest.Builder> deleteLakeFormationOptInRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
This is a convenience which creates an instance of the
DeleteLakeFormationOptInRequest.Builder
avoiding the need to create one manually viaDeleteLakeFormationOptInRequest.builder()
- Parameters:
deleteLakeFormationOptInRequest
- AConsumer
that will call methods onDeleteLakeFormationOptInRequest.Builder
to create a request.- Returns:
- Result of the DeleteLakeFormationOptIn operation returned by the service.
- See Also:
-
deleteObjectsOnCancel
default 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 callDeleteObjectsOnCancel
before writes. For more information, see Rolling Back Amazon S3 Writes.- Parameters:
deleteObjectsOnCancelRequest
-- Returns:
- Result of the DeleteObjectsOnCancel operation returned by the service.
- See Also:
-
deleteObjectsOnCancel
default 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 callDeleteObjectsOnCancel
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 viaDeleteObjectsOnCancelRequest.builder()
- Parameters:
deleteObjectsOnCancelRequest
- AConsumer
that will call methods onDeleteObjectsOnCancelRequest.Builder
to create a request.- Returns:
- Result of the DeleteObjectsOnCancel operation returned by the service.
- See Also:
-
deregisterResource
default 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.
- Parameters:
deregisterResourceRequest
-- Returns:
- Result of the DeregisterResource operation returned by the service.
- See Also:
-
deregisterResource
default 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 viaDeregisterResourceRequest.builder()
- Parameters:
deregisterResourceRequest
- AConsumer
that will call methods onDeregisterResourceRequest.Builder
to create a request.- Returns:
- Result of the DeregisterResource operation returned by the service.
- See Also:
-
describeLakeFormationIdentityCenterConfiguration
default DescribeLakeFormationIdentityCenterConfigurationResponse describeLakeFormationIdentityCenterConfiguration(DescribeLakeFormationIdentityCenterConfigurationRequest describeLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the instance ARN and application ARN for the connection.
- Parameters:
describeLakeFormationIdentityCenterConfigurationRequest
-- Returns:
- Result of the DescribeLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
describeLakeFormationIdentityCenterConfiguration
default DescribeLakeFormationIdentityCenterConfigurationResponse describeLakeFormationIdentityCenterConfiguration(Consumer<DescribeLakeFormationIdentityCenterConfigurationRequest.Builder> describeLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the instance ARN and application ARN for the connection.
This is a convenience which creates an instance of the
DescribeLakeFormationIdentityCenterConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeLakeFormationIdentityCenterConfigurationRequest.builder()
- Parameters:
describeLakeFormationIdentityCenterConfigurationRequest
- AConsumer
that will call methods onDescribeLakeFormationIdentityCenterConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DescribeLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
describeResource
default 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.
- Parameters:
describeResourceRequest
-- Returns:
- Result of the DescribeResource operation returned by the service.
- See Also:
-
describeResource
default 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 viaDescribeResourceRequest.builder()
- Parameters:
describeResourceRequest
- AConsumer
that will call methods onDescribeResourceRequest.Builder
to create a request.- Returns:
- Result of the DescribeResource operation returned by the service.
- See Also:
-
describeTransaction
default DescribeTransactionResponse describeTransaction(DescribeTransactionRequest describeTransactionRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Returns the details of a single transaction.
- Parameters:
describeTransactionRequest
-- Returns:
- Result of the DescribeTransaction operation returned by the service.
- See Also:
-
describeTransaction
default 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 viaDescribeTransactionRequest.builder()
- Parameters:
describeTransactionRequest
- AConsumer
that will call methods onDescribeTransactionRequest.Builder
to create a request.- Returns:
- Result of the DescribeTransaction operation returned by the service.
- See Also:
-
extendTransaction
default 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.
- Parameters:
extendTransactionRequest
-- Returns:
- Result of the ExtendTransaction operation returned by the service.
- See Also:
-
extendTransaction
default 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 viaExtendTransactionRequest.builder()
- Parameters:
extendTransactionRequest
- AConsumer
that will call methods onExtendTransactionRequest.Builder
to create a request.- Returns:
- Result of the ExtendTransaction operation returned by the service.
- See Also:
-
getDataCellsFilter
default GetDataCellsFilterResponse getDataCellsFilter(GetDataCellsFilterRequest getDataCellsFilterRequest) throws EntityNotFoundException, InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns a data cells filter.
- Parameters:
getDataCellsFilterRequest
-- Returns:
- Result of the GetDataCellsFilter operation returned by the service.
- See Also:
-
getDataCellsFilter
default GetDataCellsFilterResponse getDataCellsFilter(Consumer<GetDataCellsFilterRequest.Builder> getDataCellsFilterRequest) throws EntityNotFoundException, InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns a data cells filter.
This is a convenience which creates an instance of the
GetDataCellsFilterRequest.Builder
avoiding the need to create one manually viaGetDataCellsFilterRequest.builder()
- Parameters:
getDataCellsFilterRequest
- AConsumer
that will call methods onGetDataCellsFilterRequest.Builder
to create a request.- Returns:
- Result of the GetDataCellsFilter operation returned by the service.
- See Also:
-
getDataLakePrincipal
default GetDataLakePrincipalResponse getDataLakePrincipal(GetDataLakePrincipalRequest getDataLakePrincipalRequest) throws InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns the identity of the invoking principal.
- Parameters:
getDataLakePrincipalRequest
-- Returns:
- Result of the GetDataLakePrincipal operation returned by the service.
- See Also:
-
getDataLakePrincipal
default GetDataLakePrincipalResponse getDataLakePrincipal(Consumer<GetDataLakePrincipalRequest.Builder> getDataLakePrincipalRequest) throws InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns the identity of the invoking principal.
This is a convenience which creates an instance of the
GetDataLakePrincipalRequest.Builder
avoiding the need to create one manually viaGetDataLakePrincipalRequest.builder()
- Parameters:
getDataLakePrincipalRequest
- AConsumer
that will call methods onGetDataLakePrincipalRequest.Builder
to create a request.- Returns:
- Result of the GetDataLakePrincipal operation returned by the service.
- See Also:
-
getDataLakeSettings
default 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.
- Parameters:
getDataLakeSettingsRequest
-- Returns:
- Result of the GetDataLakeSettings operation returned by the service.
- See Also:
-
getDataLakeSettings
default 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 viaGetDataLakeSettingsRequest.builder()
- Parameters:
getDataLakeSettingsRequest
- AConsumer
that will call methods onGetDataLakeSettingsRequest.Builder
to create a request.- Returns:
- Result of the GetDataLakeSettings operation returned by the service.
- See Also:
-
getEffectivePermissionsForPath
default 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.- Parameters:
getEffectivePermissionsForPathRequest
-- Returns:
- Result of the GetEffectivePermissionsForPath operation returned by the service.
- See Also:
-
getEffectivePermissionsForPath
default 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 viaGetEffectivePermissionsForPathRequest.builder()
- Parameters:
getEffectivePermissionsForPathRequest
- AConsumer
that will call methods onGetEffectivePermissionsForPathRequest.Builder
to create a request.- Returns:
- Result of the GetEffectivePermissionsForPath operation returned by the service.
- See Also:
-
getEffectivePermissionsForPathPaginator
default GetEffectivePermissionsForPathIterable getEffectivePermissionsForPathPaginator(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getEffectivePermissionsForPathRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getEffectivePermissionsForPathPaginator
default GetEffectivePermissionsForPathIterable getEffectivePermissionsForPathPaginator(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetEffectivePermissionsForPathRequest.builder()
- Parameters:
getEffectivePermissionsForPathRequest
- AConsumer
that will call methods onGetEffectivePermissionsForPathRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getLFTag
default GetLfTagResponse getLFTag(GetLfTagRequest getLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns an LF-tag definition.
- Parameters:
getLfTagRequest
-- Returns:
- Result of the GetLFTag operation returned by the service.
- See Also:
-
getLFTag
default 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 viaGetLfTagRequest.builder()
- Parameters:
getLfTagRequest
- AConsumer
that will call methods onGetLfTagRequest.Builder
to create a request.- Returns:
- Result of the GetLFTag operation returned by the service.
- See Also:
-
getQueryState
default 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 toStartQueryPlanning
.- Parameters:
getQueryStateRequest
-- Returns:
- Result of the GetQueryState operation returned by the service.
- See Also:
-
getQueryState
default 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 toStartQueryPlanning
.
This is a convenience which creates an instance of the
GetQueryStateRequest.Builder
avoiding the need to create one manually viaGetQueryStateRequest.builder()
- Parameters:
getQueryStateRequest
- AConsumer
that will call methods onGetQueryStateRequest.Builder
to create a request.- Returns:
- Result of the GetQueryState operation returned by the service.
- See Also:
-
getQueryStatistics
default GetQueryStatisticsResponse getQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest) throws StatisticsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Retrieves statistics on the planning and execution of a query.
- Parameters:
getQueryStatisticsRequest
-- Returns:
- Result of the GetQueryStatistics operation returned by the service.
- See Also:
-
getQueryStatistics
default 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 viaGetQueryStatisticsRequest.builder()
- Parameters:
getQueryStatisticsRequest
- AConsumer
that will call methods onGetQueryStatisticsRequest.Builder
to create a request.- Returns:
- Result of the GetQueryStatistics operation returned by the service.
- See Also:
-
getResourceLFTags
default GetResourceLfTagsResponse getResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns the LF-tags applied to a resource.
- Parameters:
getResourceLfTagsRequest
-- Returns:
- Result of the GetResourceLFTags operation returned by the service.
- See Also:
-
getResourceLFTags
default 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 viaGetResourceLfTagsRequest.builder()
- Parameters:
getResourceLfTagsRequest
- AConsumer
that will call methods onGetResourceLfTagsRequest.Builder
to create a request.- Returns:
- Result of the GetResourceLFTags operation returned by the service.
- See Also:
-
getTableObjects
default 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.
- Parameters:
getTableObjectsRequest
-- Returns:
- Result of the GetTableObjects operation returned by the service.
- See Also:
-
getTableObjects
default 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 viaGetTableObjectsRequest.builder()
- Parameters:
getTableObjectsRequest
- AConsumer
that will call methods onGetTableObjectsRequest.Builder
to create a request.- Returns:
- Result of the GetTableObjects operation returned by the service.
- See Also:
-
getTableObjectsPaginator
default GetTableObjectsIterable getTableObjectsPaginator(GetTableObjectsRequest getTableObjectsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client.getTableObjectsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getTableObjectsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTableObjectsPaginator
default GetTableObjectsIterable getTableObjectsPaginator(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client.getTableObjectsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetTableObjectsRequest.builder()
- Parameters:
getTableObjectsRequest
- AConsumer
that will call methods onGetTableObjectsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTemporaryGluePartitionCredentials
default 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.- Parameters:
getTemporaryGluePartitionCredentialsRequest
-- Returns:
- Result of the GetTemporaryGluePartitionCredentials operation returned by the service.
- See Also:
-
getTemporaryGluePartitionCredentials
default 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 viaGetTemporaryGluePartitionCredentialsRequest.builder()
- Parameters:
getTemporaryGluePartitionCredentialsRequest
- AConsumer
that will call methods onGetTemporaryGluePartitionCredentialsRequest.Builder
to create a request.- Returns:
- Result of the GetTemporaryGluePartitionCredentials operation returned by the service.
- See Also:
-
getTemporaryGlueTableCredentials
default 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.
- Parameters:
getTemporaryGlueTableCredentialsRequest
-- Returns:
- Result of the GetTemporaryGlueTableCredentials operation returned by the service.
- See Also:
-
getTemporaryGlueTableCredentials
default 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 viaGetTemporaryGlueTableCredentialsRequest.builder()
- Parameters:
getTemporaryGlueTableCredentialsRequest
- AConsumer
that will call methods onGetTemporaryGlueTableCredentialsRequest.Builder
to create a request.- Returns:
- Result of the GetTemporaryGlueTableCredentials operation returned by the service.
- See Also:
-
getWorkUnitResults
default <ReturnT> ReturnT getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, ResponseTransformer<GetWorkUnitResultsResponse, ReturnT> responseTransformer) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationExceptionReturns the work units resulting from the query. Work units can be executed in any order and in parallel.
- Parameters:
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. SeeResponseTransformer
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.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getWorkUnitResults
default <ReturnT> ReturnT getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, ResponseTransformer<GetWorkUnitResultsResponse, ReturnT> responseTransformer) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationExceptionReturns 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 viaGetWorkUnitResultsRequest.builder()
- Parameters:
getWorkUnitResultsRequest
- AConsumer
that will call methods onGetWorkUnitResultsRequest.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. SeeResponseTransformer
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.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getWorkUnitResults
default 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.
- Parameters:
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.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getWorkUnitResults
default 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 viaGetWorkUnitResultsRequest.builder()
- Parameters:
getWorkUnitResultsRequest
- AConsumer
that will call methods onGetWorkUnitResultsRequest.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.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getWorkUnitResults
default 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.
- Parameters:
getWorkUnitResultsRequest
-- Returns:
- A
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 viaResponseInputStream.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. - See Also:
-
getWorkUnitResults
default 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 viaGetWorkUnitResultsRequest.builder()
- Parameters:
getWorkUnitResultsRequest
- AConsumer
that will call methods onGetWorkUnitResultsRequest.Builder
to create a request.- Returns:
- A
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 viaResponseInputStream.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. - See Also:
-
getWorkUnitResultsAsBytes
default 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.
- Parameters:
getWorkUnitResultsRequest
-- Returns:
- A
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 viaResponseBytes.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. - See Also:
-
getWorkUnitResultsAsBytes
default 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 viaGetWorkUnitResultsRequest.builder()
- Parameters:
getWorkUnitResultsRequest
- AConsumer
that will call methods onGetWorkUnitResultsRequest.Builder
to create a request.- Returns:
- A
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 viaResponseBytes.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. - See Also:
-
getWorkUnits
default GetWorkUnitsResponse getWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the work units generated by the
StartQueryPlanning
operation.- Parameters:
getWorkUnitsRequest
-- Returns:
- Result of the GetWorkUnits operation returned by the service.
- See Also:
-
getWorkUnits
default 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 viaGetWorkUnitsRequest.builder()
- Parameters:
getWorkUnitsRequest
- AConsumer
that will call methods onGetWorkUnitsRequest.Builder
to create a request.- Returns:
- Result of the GetWorkUnits operation returned by the service.
- See Also:
-
getWorkUnitsPaginator
default GetWorkUnitsIterable getWorkUnitsPaginator(GetWorkUnitsRequest getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client.getWorkUnitsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
getWorkUnitsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getWorkUnitsPaginator
default GetWorkUnitsIterable getWorkUnitsPaginator(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client.getWorkUnitsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaGetWorkUnitsRequest.builder()
- Parameters:
getWorkUnitsRequest
- AConsumer
that will call methods onGetWorkUnitsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
grantPermissions
default 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.
- Parameters:
grantPermissionsRequest
-- Returns:
- Result of the GrantPermissions operation returned by the service.
- See Also:
-
grantPermissions
default 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 viaGrantPermissionsRequest.builder()
- Parameters:
grantPermissionsRequest
- AConsumer
that will call methods onGrantPermissionsRequest.Builder
to create a request.- Returns:
- Result of the GrantPermissions operation returned by the service.
- See Also:
-
listDataCellsFilter
default ListDataCellsFilterResponse listDataCellsFilter(ListDataCellsFilterRequest listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Lists all the data cell filters on a table.
- Parameters:
listDataCellsFilterRequest
-- Returns:
- Result of the ListDataCellsFilter operation returned by the service.
- See Also:
-
listDataCellsFilter
default 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 viaListDataCellsFilterRequest.builder()
- Parameters:
listDataCellsFilterRequest
- AConsumer
that will call methods onListDataCellsFilterRequest.Builder
to create a request.- Returns:
- Result of the ListDataCellsFilter operation returned by the service.
- See Also:
-
listDataCellsFilterPaginator
default ListDataCellsFilterIterable listDataCellsFilterPaginator(ListDataCellsFilterRequest listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client.listDataCellsFilterPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDataCellsFilterRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataCellsFilterPaginator
default ListDataCellsFilterIterable listDataCellsFilterPaginator(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client.listDataCellsFilterPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDataCellsFilterRequest.builder()
- Parameters:
listDataCellsFilterRequest
- AConsumer
that will call methods onListDataCellsFilterRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLFTags
default ListLfTagsResponse listLFTags(ListLfTagsRequest listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Lists LF-tags that the requester has permission to view.
- Parameters:
listLfTagsRequest
-- Returns:
- Result of the ListLFTags operation returned by the service.
- See Also:
-
listLFTags
default 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 viaListLfTagsRequest.builder()
- Parameters:
listLfTagsRequest
- AConsumer
that will call methods onListLfTagsRequest.Builder
to create a request.- Returns:
- Result of the ListLFTags operation returned by the service.
- See Also:
-
listLFTagsPaginator
default ListLFTagsIterable listLFTagsPaginator(ListLfTagsRequest listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listLfTagsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLFTagsPaginator
default ListLFTagsIterable listLFTagsPaginator(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListLfTagsRequest.builder()
- Parameters:
listLfTagsRequest
- AConsumer
that will call methods onListLfTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLakeFormationOptIns
default ListLakeFormationOptInsResponse listLakeFormationOptIns(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
- Parameters:
listLakeFormationOptInsRequest
-- Returns:
- Result of the ListLakeFormationOptIns operation returned by the service.
- See Also:
-
listLakeFormationOptIns
default ListLakeFormationOptInsResponse listLakeFormationOptIns(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
This is a convenience which creates an instance of the
ListLakeFormationOptInsRequest.Builder
avoiding the need to create one manually viaListLakeFormationOptInsRequest.builder()
- Parameters:
listLakeFormationOptInsRequest
- AConsumer
that will call methods onListLakeFormationOptInsRequest.Builder
to create a request.- Returns:
- Result of the ListLakeFormationOptIns operation returned by the service.
- See Also:
-
listLakeFormationOptInsPaginator
default ListLakeFormationOptInsIterable listLakeFormationOptInsPaginator(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)
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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client.listLakeFormationOptInsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client .listLakeFormationOptInsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client.listLakeFormationOptInsPaginator(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
listLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)
operation.- Parameters:
listLakeFormationOptInsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLakeFormationOptInsPaginator
default ListLakeFormationOptInsIterable listLakeFormationOptInsPaginator(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)
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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client.listLakeFormationOptInsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client .listLakeFormationOptInsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client.listLakeFormationOptInsPaginator(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
listLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)
operation.
This is a convenience which creates an instance of the
ListLakeFormationOptInsRequest.Builder
avoiding the need to create one manually viaListLakeFormationOptInsRequest.builder()
- Parameters:
listLakeFormationOptInsRequest
- AConsumer
that will call methods onListLakeFormationOptInsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissions
default 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.
- Parameters:
listPermissionsRequest
-- Returns:
- Result of the ListPermissions operation returned by the service.
- See Also:
-
listPermissions
default 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 viaListPermissionsRequest.builder()
- Parameters:
listPermissionsRequest
- AConsumer
that will call methods onListPermissionsRequest.Builder
to create a request.- Returns:
- Result of the ListPermissions operation returned by the service.
- See Also:
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listPermissionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListPermissionsRequest.builder()
- Parameters:
listPermissionsRequest
- AConsumer
that will call methods onListPermissionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResources
default ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Lists the resources registered to be managed by the Data Catalog.
- Parameters:
listResourcesRequest
-- Returns:
- Result of the ListResources operation returned by the service.
- See Also:
-
listResources
default 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 viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListResources operation returned by the service.
- See Also:
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTableStorageOptimizers
default ListTableStorageOptimizersResponse listTableStorageOptimizers(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException Returns the configuration of all storage optimizers associated with a specified table.
- Parameters:
listTableStorageOptimizersRequest
-- Returns:
- Result of the ListTableStorageOptimizers operation returned by the service.
- See Also:
-
listTableStorageOptimizers
default 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 viaListTableStorageOptimizersRequest.builder()
- Parameters:
listTableStorageOptimizersRequest
- AConsumer
that will call methods onListTableStorageOptimizersRequest.Builder
to create a request.- Returns:
- Result of the ListTableStorageOptimizers operation returned by the service.
- See Also:
-
listTableStorageOptimizersPaginator
default ListTableStorageOptimizersIterable listTableStorageOptimizersPaginator(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client.listTableStorageOptimizersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listTableStorageOptimizersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTableStorageOptimizersPaginator
default ListTableStorageOptimizersIterable listTableStorageOptimizersPaginator(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client.listTableStorageOptimizersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTableStorageOptimizersRequest.builder()
- Parameters:
listTableStorageOptimizersRequest
- AConsumer
that will call methods onListTableStorageOptimizersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTransactions
default 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.
- Parameters:
listTransactionsRequest
-- Returns:
- Result of the ListTransactions operation returned by the service.
- See Also:
-
listTransactions
default 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 viaListTransactionsRequest.builder()
- Parameters:
listTransactionsRequest
- AConsumer
that will call methods onListTransactionsRequest.Builder
to create a request.- Returns:
- Result of the ListTransactions operation returned by the service.
- See Also:
-
listTransactionsPaginator
default ListTransactionsIterable listTransactionsPaginator(ListTransactionsRequest listTransactionsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client.listTransactionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listTransactionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTransactionsPaginator
default ListTransactionsIterable listTransactionsPaginator(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client.listTransactionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTransactionsRequest.builder()
- Parameters:
listTransactionsRequest
- AConsumer
that will call methods onListTransactionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putDataLakeSettings
default 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.
- Parameters:
putDataLakeSettingsRequest
-- Returns:
- Result of the PutDataLakeSettings operation returned by the service.
- See Also:
-
putDataLakeSettings
default 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 viaPutDataLakeSettingsRequest.builder()
- Parameters:
putDataLakeSettingsRequest
- AConsumer
that will call methods onPutDataLakeSettingsRequest.Builder
to create a request.- Returns:
- Result of the PutDataLakeSettings operation returned by the service.
- See Also:
-
registerResource
default 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 theRoleArn
:arn:aws:iam::12345:role/my-data-access-role
- Parameters:
registerResourceRequest
-- Returns:
- Result of the RegisterResource operation returned by the service.
- See Also:
-
registerResource
default 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 theRoleArn
: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 viaRegisterResourceRequest.builder()
- Parameters:
registerResourceRequest
- AConsumer
that will call methods onRegisterResourceRequest.Builder
to create a request.- Returns:
- Result of the RegisterResource operation returned by the service.
- See Also:
-
removeLFTagsFromResource
default 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.- Parameters:
removeLfTagsFromResourceRequest
-- Returns:
- Result of the RemoveLFTagsFromResource operation returned by the service.
- See Also:
-
removeLFTagsFromResource
default 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 viaRemoveLfTagsFromResourceRequest.builder()
- Parameters:
removeLfTagsFromResourceRequest
- AConsumer
that will call methods onRemoveLfTagsFromResourceRequest.Builder
to create a request.- Returns:
- Result of the RemoveLFTagsFromResource operation returned by the service.
- See Also:
-
revokePermissions
default 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.
- Parameters:
revokePermissionsRequest
-- Returns:
- Result of the RevokePermissions operation returned by the service.
- See Also:
-
revokePermissions
default 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 viaRevokePermissionsRequest.builder()
- Parameters:
revokePermissionsRequest
- AConsumer
that will call methods onRevokePermissionsRequest.Builder
to create a request.- Returns:
- Result of the RevokePermissions operation returned by the service.
- See Also:
-
searchDatabasesByLFTags
default SearchDatabasesByLfTagsResponse searchDatabasesByLFTags(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This operation allows a search on
DATABASE
resources byTagCondition
. This operation is used by admins who want to grant user permissions on certainTagConditions
. Before making a grant, the admin can useSearchDatabasesByTags
to find all resources where the givenTagConditions
are valid to verify whether the returned resources can be shared.- Parameters:
searchDatabasesByLfTagsRequest
-- Returns:
- Result of the SearchDatabasesByLFTags operation returned by the service.
- See Also:
-
searchDatabasesByLFTags
default SearchDatabasesByLfTagsResponse searchDatabasesByLFTags(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This operation allows a search on
DATABASE
resources byTagCondition
. This operation is used by admins who want to grant user permissions on certainTagConditions
. Before making a grant, the admin can useSearchDatabasesByTags
to find all resources where the givenTagConditions
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 viaSearchDatabasesByLfTagsRequest.builder()
- Parameters:
searchDatabasesByLfTagsRequest
- AConsumer
that will call methods onSearchDatabasesByLfTagsRequest.Builder
to create a request.- Returns:
- Result of the SearchDatabasesByLFTags operation returned by the service.
- See Also:
-
searchDatabasesByLFTagsPaginator
default SearchDatabasesByLFTagsIterable searchDatabasesByLFTagsPaginator(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client.searchDatabasesByLFTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
searchDatabasesByLfTagsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchDatabasesByLFTagsPaginator
default SearchDatabasesByLFTagsIterable searchDatabasesByLFTagsPaginator(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client.searchDatabasesByLFTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchDatabasesByLfTagsRequest.builder()
- Parameters:
searchDatabasesByLfTagsRequest
- AConsumer
that will call methods onSearchDatabasesByLfTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchTablesByLFTags
default SearchTablesByLfTagsResponse searchTablesByLFTags(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This operation allows a search on
TABLE
resources byLFTag
s. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can useSearchTablesByLFTags
to find all resources where the givenLFTag
s are valid to verify whether the returned resources can be shared.- Parameters:
searchTablesByLfTagsRequest
-- Returns:
- Result of the SearchTablesByLFTags operation returned by the service.
- See Also:
-
searchTablesByLFTags
default SearchTablesByLfTagsResponse searchTablesByLFTags(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This operation allows a search on
TABLE
resources byLFTag
s. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can useSearchTablesByLFTags
to find all resources where the givenLFTag
s 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 viaSearchTablesByLfTagsRequest.builder()
- Parameters:
searchTablesByLfTagsRequest
- AConsumer
that will call methods onSearchTablesByLfTagsRequest.Builder
to create a request.- Returns:
- Result of the SearchTablesByLFTags operation returned by the service.
- See Also:
-
searchTablesByLFTagsPaginator
default SearchTablesByLFTagsIterable searchTablesByLFTagsPaginator(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client.searchTablesByLFTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
searchTablesByLfTagsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchTablesByLFTagsPaginator
default SearchTablesByLFTagsIterable searchTablesByLFTagsPaginator(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException 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 Streamsoftware.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client.searchTablesByLFTagsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchTablesByLfTagsRequest.builder()
- Parameters:
searchTablesByLfTagsRequest
- AConsumer
that will call methods onSearchTablesByLfTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
startQueryPlanning
default 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.- Parameters:
startQueryPlanningRequest
-- Returns:
- Result of the StartQueryPlanning operation returned by the service.
- See Also:
-
startQueryPlanning
default 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 viaStartQueryPlanningRequest.builder()
- Parameters:
startQueryPlanningRequest
- AConsumer
that will call methods onStartQueryPlanningRequest.Builder
to create a request.- Returns:
- Result of the StartQueryPlanning operation returned by the service.
- See Also:
-
startTransaction
default 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.
- Parameters:
startTransactionRequest
-- Returns:
- Result of the StartTransaction operation returned by the service.
- See Also:
-
startTransaction
default 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 viaStartTransactionRequest.builder()
- Parameters:
startTransactionRequest
- AConsumer
that will call methods onStartTransactionRequest.Builder
to create a request.- Returns:
- Result of the StartTransaction operation returned by the service.
- See Also:
-
updateDataCellsFilter
default UpdateDataCellsFilterResponse updateDataCellsFilter(UpdateDataCellsFilterRequest updateDataCellsFilterRequest) throws ConcurrentModificationException, InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Updates a data cell filter.
- Parameters:
updateDataCellsFilterRequest
-- Returns:
- Result of the UpdateDataCellsFilter operation returned by the service.
- See Also:
-
updateDataCellsFilter
default UpdateDataCellsFilterResponse updateDataCellsFilter(Consumer<UpdateDataCellsFilterRequest.Builder> updateDataCellsFilterRequest) throws ConcurrentModificationException, InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Updates a data cell filter.
This is a convenience which creates an instance of the
UpdateDataCellsFilterRequest.Builder
avoiding the need to create one manually viaUpdateDataCellsFilterRequest.builder()
- Parameters:
updateDataCellsFilterRequest
- AConsumer
that will call methods onUpdateDataCellsFilterRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataCellsFilter operation returned by the service.
- See Also:
-
updateLFTag
default 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.
- Parameters:
updateLfTagRequest
-- Returns:
- Result of the UpdateLFTag operation returned by the service.
- See Also:
-
updateLFTag
default 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 viaUpdateLfTagRequest.builder()
- Parameters:
updateLfTagRequest
- AConsumer
that will call methods onUpdateLfTagRequest.Builder
to create a request.- Returns:
- Result of the UpdateLFTag operation returned by the service.
- See Also:
-
updateLakeFormationIdentityCenterConfiguration
default UpdateLakeFormationIdentityCenterConfigurationResponse updateLakeFormationIdentityCenterConfiguration(UpdateLakeFormationIdentityCenterConfigurationRequest updateLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Updates the IAM Identity Center connection parameters.
- Parameters:
updateLakeFormationIdentityCenterConfigurationRequest
-- Returns:
- Result of the UpdateLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
updateLakeFormationIdentityCenterConfiguration
default UpdateLakeFormationIdentityCenterConfigurationResponse updateLakeFormationIdentityCenterConfiguration(Consumer<UpdateLakeFormationIdentityCenterConfigurationRequest.Builder> updateLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Updates the IAM Identity Center connection parameters.
This is a convenience which creates an instance of the
UpdateLakeFormationIdentityCenterConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateLakeFormationIdentityCenterConfigurationRequest.builder()
- Parameters:
updateLakeFormationIdentityCenterConfigurationRequest
- AConsumer
that will call methods onUpdateLakeFormationIdentityCenterConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
updateResource
default 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.
- Parameters:
updateResourceRequest
-- Returns:
- Result of the UpdateResource operation returned by the service.
- See Also:
-
updateResource
default 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 viaUpdateResourceRequest.builder()
- Parameters:
updateResourceRequest
- AConsumer
that will call methods onUpdateResourceRequest.Builder
to create a request.- Returns:
- Result of the UpdateResource operation returned by the service.
- See Also:
-
updateTableObjects
default 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.
- Parameters:
updateTableObjectsRequest
-- Returns:
- Result of the UpdateTableObjects operation returned by the service.
- See Also:
-
updateTableObjects
default 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 viaUpdateTableObjectsRequest.builder()
- Parameters:
updateTableObjectsRequest
- AConsumer
that will call methods onUpdateTableObjectsRequest.Builder
to create a request.- Returns:
- Result of the UpdateTableObjects operation returned by the service.
- See Also:
-
updateTableStorageOptimizer
default UpdateTableStorageOptimizerResponse updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest updateTableStorageOptimizerRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException Updates the configuration of the storage optimizers for a table.
- Parameters:
updateTableStorageOptimizerRequest
-- Returns:
- Result of the UpdateTableStorageOptimizer operation returned by the service.
- See Also:
-
updateTableStorageOptimizer
default 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 viaUpdateTableStorageOptimizerRequest.builder()
- Parameters:
updateTableStorageOptimizerRequest
- AConsumer
that will call methods onUpdateTableStorageOptimizerRequest.Builder
to create a request.- Returns:
- Result of the UpdateTableStorageOptimizer operation returned by the service.
- See Also:
-
create
Create aLakeFormationClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aLakeFormationClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-