Interface LakeFormationAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
Defines the public endpoint for the Lake Formation service.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionaddLFTagsToResource(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest) Attaches one or more LF-tags to an existing resource.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.batchGrantPermissions(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest) Batch operation to grant permissions to the principal.batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest) Batch operation to grant permissions to the principal.batchRevokePermissions(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest) Batch operation to revoke permissions from the principal.batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest) Batch operation to revoke permissions from the principal.builder()Create a builder that can be used to configure and create aLakeFormationAsyncClient.cancelTransaction(Consumer<CancelTransactionRequest.Builder> cancelTransactionRequest) Attempts to cancel the specified transaction.cancelTransaction(CancelTransactionRequest cancelTransactionRequest) Attempts to cancel the specified transaction.commitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest) Attempts to commit the specified transaction.commitTransaction(CommitTransactionRequest commitTransactionRequest) Attempts to commit the specified transaction.static LakeFormationAsyncClientcreate()Create aLakeFormationAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createDataCellsFilter(Consumer<CreateDataCellsFilterRequest.Builder> createDataCellsFilterRequest) Creates a data cell filter to allow one to grant access to certain columns on certain rows.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.createLakeFormationOptIn(Consumer<CreateLakeFormationOptInRequest.Builder> createLakeFormationOptInRequest) Enforce Lake Formation permissions for the given databases, tables, and principals.createLakeFormationOptIn(CreateLakeFormationOptInRequest createLakeFormationOptInRequest) Enforce Lake Formation permissions for the given databases, tables, and principals.default CompletableFuture<CreateLfTagResponse> createLFTag(Consumer<CreateLfTagRequest.Builder> createLfTagRequest) Creates an LF-tag with the specified name and values.default CompletableFuture<CreateLfTagResponse> createLFTag(CreateLfTagRequest createLfTagRequest) Creates an LF-tag with the specified name and values.createLFTagExpression(Consumer<CreateLfTagExpressionRequest.Builder> createLfTagExpressionRequest) Creates a new LF-Tag expression with the provided name, description, catalog ID, and expression body.createLFTagExpression(CreateLfTagExpressionRequest createLfTagExpressionRequest) Creates a new LF-Tag expression with the provided name, description, catalog ID, and expression body.deleteDataCellsFilter(Consumer<DeleteDataCellsFilterRequest.Builder> deleteDataCellsFilterRequest) Deletes a data cell filter.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.deleteLakeFormationOptIn(Consumer<DeleteLakeFormationOptInRequest.Builder> deleteLakeFormationOptInRequest) Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.deleteLakeFormationOptIn(DeleteLakeFormationOptInRequest deleteLakeFormationOptInRequest) Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.default CompletableFuture<DeleteLfTagResponse> deleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest) Deletes the specified LF-tag given a key name.default CompletableFuture<DeleteLfTagResponse> deleteLFTag(DeleteLfTagRequest deleteLfTagRequest) Deletes the specified LF-tag given a key name.deleteLFTagExpression(Consumer<DeleteLfTagExpressionRequest.Builder> deleteLfTagExpressionRequest) Deletes the LF-Tag expression.deleteLFTagExpression(DeleteLfTagExpressionRequest deleteLfTagExpressionRequest) Deletes the LF-Tag expression.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.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.deregisterResource(Consumer<DeregisterResourceRequest.Builder> deregisterResourceRequest) Deregisters the resource as managed by the Data Catalog.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.describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) Retrieves the current data access role for the given resource registered in Lake Formation.describeResource(DescribeResourceRequest describeResourceRequest) Retrieves the current data access role for the given resource registered in Lake Formation.describeTransaction(Consumer<DescribeTransactionRequest.Builder> describeTransactionRequest) Returns the details of a single transaction.describeTransaction(DescribeTransactionRequest describeTransactionRequest) Returns the details of a single transaction.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.extendTransaction(ExtendTransactionRequest extendTransactionRequest) Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.getDataCellsFilter(Consumer<GetDataCellsFilterRequest.Builder> getDataCellsFilterRequest) Returns a data cells filter.getDataCellsFilter(GetDataCellsFilterRequest getDataCellsFilterRequest) Returns a data cells filter.getDataLakePrincipal(Consumer<GetDataLakePrincipalRequest.Builder> getDataLakePrincipalRequest) Returns the identity of the invoking principal.getDataLakePrincipal(GetDataLakePrincipalRequest getDataLakePrincipalRequest) Returns the identity of the invoking principal.getDataLakeSettings(Consumer<GetDataLakeSettingsRequest.Builder> getDataLakeSettingsRequest) Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.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 CompletableFuture<GetLfTagResponse> getLFTag(Consumer<GetLfTagRequest.Builder> getLfTagRequest) Returns an LF-tag definition.default CompletableFuture<GetLfTagResponse> getLFTag(GetLfTagRequest getLfTagRequest) Returns an LF-tag definition.getLFTagExpression(Consumer<GetLfTagExpressionRequest.Builder> getLfTagExpressionRequest) Returns the details about the LF-Tag expression.getLFTagExpression(GetLfTagExpressionRequest getLfTagExpressionRequest) Returns the details about the LF-Tag expression.default CompletableFuture<GetQueryStateResponse> getQueryState(Consumer<GetQueryStateRequest.Builder> getQueryStateRequest) Returns the state of a query previously submitted.default CompletableFuture<GetQueryStateResponse> getQueryState(GetQueryStateRequest getQueryStateRequest) Returns the state of a query previously submitted.getQueryStatistics(Consumer<GetQueryStatisticsRequest.Builder> getQueryStatisticsRequest) Retrieves statistics on the planning and execution of a query.getQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest) Retrieves statistics on the planning and execution of a query.getResourceLFTags(Consumer<GetResourceLfTagsRequest.Builder> getResourceLfTagsRequest) Returns the LF-tags applied to a resource.getResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest) Returns the LF-tags applied to a resource.default CompletableFuture<GetTableObjectsResponse> getTableObjects(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) Returns the set of Amazon S3 objects that make up the specified governed table.default CompletableFuture<GetTableObjectsResponse> getTableObjects(GetTableObjectsRequest getTableObjectsRequest) Returns the set of Amazon S3 objects that make up the specified governed table.default GetTableObjectsPublishergetTableObjectsPaginator(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) This is a variant ofgetTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)operation.default GetTableObjectsPublishergetTableObjectsPaginator(GetTableObjectsRequest getTableObjectsRequest) This is a variant ofgetTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)operation.getTemporaryGluePartitionCredentials(Consumer<GetTemporaryGluePartitionCredentialsRequest.Builder> getTemporaryGluePartitionCredentialsRequest) This API is identical toGetTemporaryTableCredentialsexcept that this is used when the target Data Catalog resource is of type Partition.getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest getTemporaryGluePartitionCredentialsRequest) This API is identical toGetTemporaryTableCredentialsexcept 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, Path destinationPath) Returns the work units resulting from the query.default <ReturnT> CompletableFuture<ReturnT> getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, AsyncResponseTransformer<GetWorkUnitResultsResponse, ReturnT> asyncResponseTransformer) Returns the work units resulting from the query.getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, Path destinationPath) Returns the work units resulting from the query.default <ReturnT> CompletableFuture<ReturnT> getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, AsyncResponseTransformer<GetWorkUnitResultsResponse, ReturnT> asyncResponseTransformer) Returns the work units resulting from the query.default CompletableFuture<GetWorkUnitsResponse> getWorkUnits(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) Retrieves the work units generated by theStartQueryPlanningoperation.default CompletableFuture<GetWorkUnitsResponse> getWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest) Retrieves the work units generated by theStartQueryPlanningoperation.default GetWorkUnitsPublishergetWorkUnitsPaginator(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) This is a variant ofgetWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)operation.default GetWorkUnitsPublishergetWorkUnitsPaginator(GetWorkUnitsRequest getWorkUnitsRequest) This is a variant ofgetWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)operation.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.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.listDataCellsFilter(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) Lists all the data cell filters on a table.listDataCellsFilter(ListDataCellsFilterRequest listDataCellsFilterRequest) Lists all the data cell filters on a table.default ListDataCellsFilterPublisherlistDataCellsFilterPaginator(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) This is a variant oflistDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)operation.default ListDataCellsFilterPublisherlistDataCellsFilterPaginator(ListDataCellsFilterRequest listDataCellsFilterRequest) This is a variant oflistDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)operation.listLakeFormationOptIns(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.listLakeFormationOptIns(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.default ListLakeFormationOptInsPublisherlistLakeFormationOptInsPaginator(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) This is a variant oflistLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)operation.default ListLakeFormationOptInsPublisherlistLakeFormationOptInsPaginator(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) This is a variant oflistLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)operation.listLFTagExpressions(Consumer<ListLfTagExpressionsRequest.Builder> listLfTagExpressionsRequest) Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions.listLFTagExpressions(ListLfTagExpressionsRequest listLfTagExpressionsRequest) Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions.default ListLFTagExpressionsPublisherlistLFTagExpressionsPaginator(Consumer<ListLfTagExpressionsRequest.Builder> listLfTagExpressionsRequest) This is a variant oflistLFTagExpressions(software.amazon.awssdk.services.lakeformation.model.ListLfTagExpressionsRequest)operation.default ListLFTagExpressionsPublisherlistLFTagExpressionsPaginator(ListLfTagExpressionsRequest listLfTagExpressionsRequest) This is a variant oflistLFTagExpressions(software.amazon.awssdk.services.lakeformation.model.ListLfTagExpressionsRequest)operation.default CompletableFuture<ListLfTagsResponse> listLFTags(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) Lists LF-tags that the requester has permission to view.default CompletableFuture<ListLfTagsResponse> listLFTags(ListLfTagsRequest listLfTagsRequest) Lists LF-tags that the requester has permission to view.default ListLFTagsPublisherlistLFTagsPaginator(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) This is a variant oflistLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)operation.default ListLFTagsPublisherlistLFTagsPaginator(ListLfTagsRequest listLfTagsRequest) This is a variant oflistLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)operation.default CompletableFuture<ListPermissionsResponse> listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.default CompletableFuture<ListPermissionsResponse> listPermissions(ListPermissionsRequest listPermissionsRequest) Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.default ListPermissionsPublisherlistPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)operation.default ListPermissionsPublisherlistPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)operation.default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Lists the resources registered to be managed by the Data Catalog.default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest) Lists the resources registered to be managed by the Data Catalog.default ListResourcesPublisherlistResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)operation.default ListResourcesPublisherlistResourcesPaginator(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.listTransactions(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) Returns metadata about transactions and their status.listTransactions(ListTransactionsRequest listTransactionsRequest) Returns metadata about transactions and their status.default ListTransactionsPublisherlistTransactionsPaginator(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) This is a variant oflistTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)operation.default ListTransactionsPublisherlistTransactionsPaginator(ListTransactionsRequest listTransactionsRequest) This is a variant oflistTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)operation.putDataLakeSettings(Consumer<PutDataLakeSettingsRequest.Builder> putDataLakeSettingsRequest) Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest) Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.registerResource(Consumer<RegisterResourceRequest.Builder> registerResourceRequest) Registers the resource as managed by the Data Catalog.registerResource(RegisterResourceRequest registerResourceRequest) Registers the resource as managed by the Data Catalog.removeLFTagsFromResource(Consumer<RemoveLfTagsFromResourceRequest.Builder> removeLfTagsFromResourceRequest) Removes an LF-tag from the resource.removeLFTagsFromResource(RemoveLfTagsFromResourceRequest removeLfTagsFromResourceRequest) Removes an LF-tag from the resource.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.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.searchDatabasesByLFTags(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) This operation allows a search onDATABASEresources byTagCondition.searchDatabasesByLFTags(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) This operation allows a search onDATABASEresources byTagCondition.default SearchDatabasesByLFTagsPublishersearchDatabasesByLFTagsPaginator(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) This is a variant ofsearchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)operation.default SearchDatabasesByLFTagsPublishersearchDatabasesByLFTagsPaginator(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) This is a variant ofsearchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)operation.searchTablesByLFTags(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) This operation allows a search onTABLEresources byLFTags.searchTablesByLFTags(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) This operation allows a search onTABLEresources byLFTags.default SearchTablesByLFTagsPublishersearchTablesByLFTagsPaginator(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) This is a variant ofsearchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)operation.default SearchTablesByLFTagsPublishersearchTablesByLFTagsPaginator(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., ClientOverrideConfigurationstartQueryPlanning(Consumer<StartQueryPlanningRequest.Builder> startQueryPlanningRequest) Submits a request to process a query statement.startQueryPlanning(StartQueryPlanningRequest startQueryPlanningRequest) Submits a request to process a query statement.startTransaction(Consumer<StartTransactionRequest.Builder> startTransactionRequest) Starts a new transaction and returns its transaction ID.startTransaction(StartTransactionRequest startTransactionRequest) Starts a new transaction and returns its transaction ID.updateDataCellsFilter(Consumer<UpdateDataCellsFilterRequest.Builder> updateDataCellsFilterRequest) Updates a data cell filter.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 CompletableFuture<UpdateLfTagResponse> updateLFTag(Consumer<UpdateLfTagRequest.Builder> updateLfTagRequest) Updates the list of possible values for the specified LF-tag key.default CompletableFuture<UpdateLfTagResponse> updateLFTag(UpdateLfTagRequest updateLfTagRequest) Updates the list of possible values for the specified LF-tag key.updateLFTagExpression(Consumer<UpdateLfTagExpressionRequest.Builder> updateLfTagExpressionRequest) Updates the name of the LF-Tag expression to the new description and expression body provided.updateLFTagExpression(UpdateLfTagExpressionRequest updateLfTagExpressionRequest) Updates the name of the LF-Tag expression to the new description and expression body provided.default CompletableFuture<UpdateResourceResponse> updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) Updates the data access role used for vending access to the given (registered) resource in Lake Formation.default CompletableFuture<UpdateResourceResponse> updateResource(UpdateResourceRequest updateResourceRequest) Updates the data access role used for vending access to the given (registered) resource in Lake Formation.updateTableObjects(Consumer<UpdateTableObjectsRequest.Builder> updateTableObjectsRequest) Updates the manifest of Amazon S3 objects that make up the specified governed table.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
closeMethods 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 CompletableFuture<AddLfTagsToResourceResponse> addLFTagsToResource(AddLfTagsToResourceRequest addLfTagsToResourceRequest) Attaches one or more LF-tags to an existing resource.
- Parameters:
addLfTagsToResourceRequest-- Returns:
- A Java Future containing the result of the AddLFTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
addLFTagsToResource
default CompletableFuture<AddLfTagsToResourceResponse> addLFTagsToResource(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest) Attaches one or more LF-tags to an existing resource.
This is a convenience which creates an instance of the
AddLfTagsToResourceRequest.Builderavoiding the need to create one manually viaAddLfTagsToResourceRequest.builder()- Parameters:
addLfTagsToResourceRequest- AConsumerthat will call methods onAddLfTagsToResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AddLFTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
assumeDecoratedRoleWithSAML
default CompletableFuture<AssumeDecoratedRoleWithSamlResponse> assumeDecoratedRoleWithSAML(AssumeDecoratedRoleWithSamlRequest assumeDecoratedRoleWithSamlRequest) Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.
This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API
GetDataAccess. Therefore, all SAML roles that can be assumed viaAssumeDecoratedRoleWithSAMLmust at a minimum includelakeformation:GetDataAccessin their role policies. A typical IAM policy attached to such a role would look as follows:- Parameters:
assumeDecoratedRoleWithSamlRequest-- Returns:
- A Java Future containing the result of the AssumeDecoratedRoleWithSAML operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
assumeDecoratedRoleWithSAML
default CompletableFuture<AssumeDecoratedRoleWithSamlResponse> 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. 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 viaAssumeDecoratedRoleWithSAMLmust at a minimum includelakeformation:GetDataAccessin 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.Builderavoiding the need to create one manually viaAssumeDecoratedRoleWithSamlRequest.builder()- Parameters:
assumeDecoratedRoleWithSamlRequest- AConsumerthat will call methods onAssumeDecoratedRoleWithSamlRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AssumeDecoratedRoleWithSAML operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGrantPermissions
default CompletableFuture<BatchGrantPermissionsResponse> batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest) Batch operation to grant permissions to the principal.
- Parameters:
batchGrantPermissionsRequest-- Returns:
- A Java Future containing the result of the BatchGrantPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGrantPermissions
default CompletableFuture<BatchGrantPermissionsResponse> batchGrantPermissions(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest) Batch operation to grant permissions to the principal.
This is a convenience which creates an instance of the
BatchGrantPermissionsRequest.Builderavoiding the need to create one manually viaBatchGrantPermissionsRequest.builder()- Parameters:
batchGrantPermissionsRequest- AConsumerthat will call methods onBatchGrantPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchGrantPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchRevokePermissions
default CompletableFuture<BatchRevokePermissionsResponse> batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest) Batch operation to revoke permissions from the principal.
- Parameters:
batchRevokePermissionsRequest-- Returns:
- A Java Future containing the result of the BatchRevokePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchRevokePermissions
default CompletableFuture<BatchRevokePermissionsResponse> batchRevokePermissions(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest) Batch operation to revoke permissions from the principal.
This is a convenience which creates an instance of the
BatchRevokePermissionsRequest.Builderavoiding the need to create one manually viaBatchRevokePermissionsRequest.builder()- Parameters:
batchRevokePermissionsRequest- AConsumerthat will call methods onBatchRevokePermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchRevokePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelTransaction
default CompletableFuture<CancelTransactionResponse> cancelTransaction(CancelTransactionRequest cancelTransactionRequest) Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
- Parameters:
cancelTransactionRequest-- Returns:
- A Java Future containing the result of the CancelTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCommitInProgressException Contains details about an error related to a transaction commit that was in progress.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelTransaction
default CompletableFuture<CancelTransactionResponse> cancelTransaction(Consumer<CancelTransactionRequest.Builder> cancelTransactionRequest) 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.Builderavoiding the need to create one manually viaCancelTransactionRequest.builder()- Parameters:
cancelTransactionRequest- AConsumerthat will call methods onCancelTransactionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCommitInProgressException Contains details about an error related to a transaction commit that was in progress.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
commitTransaction
default CompletableFuture<CommitTransactionResponse> commitTransaction(CommitTransactionRequest commitTransactionRequest) Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.
- Parameters:
commitTransactionRequest-- Returns:
- A Java Future containing the result of the CommitTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
commitTransaction
default CompletableFuture<CommitTransactionResponse> commitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest) Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.
This is a convenience which creates an instance of the
CommitTransactionRequest.Builderavoiding the need to create one manually viaCommitTransactionRequest.builder()- Parameters:
commitTransactionRequest- AConsumerthat will call methods onCommitTransactionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CommitTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataCellsFilter
default CompletableFuture<CreateDataCellsFilterResponse> createDataCellsFilter(CreateDataCellsFilterRequest createDataCellsFilterRequest) Creates a data cell filter to allow one to grant access to certain columns on certain rows.
- Parameters:
createDataCellsFilterRequest-- Returns:
- A Java Future containing the result of the CreateDataCellsFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AlreadyExistsException A resource to be created or added already exists.
- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- ResourceNumberLimitExceededException A resource numerical limit was exceeded.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataCellsFilter
default CompletableFuture<CreateDataCellsFilterResponse> createDataCellsFilter(Consumer<CreateDataCellsFilterRequest.Builder> createDataCellsFilterRequest) 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.Builderavoiding the need to create one manually viaCreateDataCellsFilterRequest.builder()- Parameters:
createDataCellsFilterRequest- AConsumerthat will call methods onCreateDataCellsFilterRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDataCellsFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AlreadyExistsException A resource to be created or added already exists.
- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- ResourceNumberLimitExceededException A resource numerical limit was exceeded.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLFTag
Creates an LF-tag with the specified name and values.
- Parameters:
createLfTagRequest-- Returns:
- A Java Future containing the result of the CreateLFTag operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- ResourceNumberLimitExceededException A resource numerical limit was exceeded.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLFTag
default CompletableFuture<CreateLfTagResponse> createLFTag(Consumer<CreateLfTagRequest.Builder> createLfTagRequest) Creates an LF-tag with the specified name and values.
This is a convenience which creates an instance of the
CreateLfTagRequest.Builderavoiding the need to create one manually viaCreateLfTagRequest.builder()- Parameters:
createLfTagRequest- AConsumerthat will call methods onCreateLfTagRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateLFTag operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- ResourceNumberLimitExceededException A resource numerical limit was exceeded.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLFTagExpression
default CompletableFuture<CreateLfTagExpressionResponse> createLFTagExpression(CreateLfTagExpressionRequest createLfTagExpressionRequest) Creates a new LF-Tag expression with the provided name, description, catalog ID, and expression body. This call fails if a LF-Tag expression with the same name already exists in the caller’s account or if the underlying LF-Tags don't exist. To call this API operation, caller needs the following Lake Formation permissions:
CREATE_LF_TAG_EXPRESSIONon the root catalog resource.GRANT_WITH_LF_TAG_EXPRESSIONon all underlying LF-Tag key:value pairs included in the expression.- Parameters:
createLfTagExpressionRequest-- Returns:
- A Java Future containing the result of the CreateLFTagExpression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- ResourceNumberLimitExceededException A resource numerical limit was exceeded.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- EntityNotFoundException A specified entity does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLFTagExpression
default CompletableFuture<CreateLfTagExpressionResponse> createLFTagExpression(Consumer<CreateLfTagExpressionRequest.Builder> createLfTagExpressionRequest) Creates a new LF-Tag expression with the provided name, description, catalog ID, and expression body. This call fails if a LF-Tag expression with the same name already exists in the caller’s account or if the underlying LF-Tags don't exist. To call this API operation, caller needs the following Lake Formation permissions:
CREATE_LF_TAG_EXPRESSIONon the root catalog resource.GRANT_WITH_LF_TAG_EXPRESSIONon all underlying LF-Tag key:value pairs included in the expression.
This is a convenience which creates an instance of the
CreateLfTagExpressionRequest.Builderavoiding the need to create one manually viaCreateLfTagExpressionRequest.builder()- Parameters:
createLfTagExpressionRequest- AConsumerthat will call methods onCreateLfTagExpressionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateLFTagExpression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- ResourceNumberLimitExceededException A resource numerical limit was exceeded.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- EntityNotFoundException A specified entity does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLakeFormationIdentityCenterConfiguration
default CompletableFuture<CreateLakeFormationIdentityCenterConfigurationResponse> 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.
- Parameters:
createLakeFormationIdentityCenterConfigurationRequest-- Returns:
- A Java Future containing the result of the CreateLakeFormationIdentityCenterConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- AlreadyExistsException A resource to be created or added already exists.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLakeFormationIdentityCenterConfiguration
default CompletableFuture<CreateLakeFormationIdentityCenterConfigurationResponse> 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.
This is a convenience which creates an instance of the
CreateLakeFormationIdentityCenterConfigurationRequest.Builderavoiding the need to create one manually viaCreateLakeFormationIdentityCenterConfigurationRequest.builder()- Parameters:
createLakeFormationIdentityCenterConfigurationRequest- AConsumerthat will call methods onCreateLakeFormationIdentityCenterConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateLakeFormationIdentityCenterConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- AlreadyExistsException A resource to be created or added already exists.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLakeFormationOptIn
default CompletableFuture<CreateLakeFormationOptInResponse> createLakeFormationOptIn(CreateLakeFormationOptInRequest createLakeFormationOptInRequest) Enforce Lake Formation permissions for the given databases, tables, and principals.
- Parameters:
createLakeFormationOptInRequest-- Returns:
- A Java Future containing the result of the CreateLakeFormationOptIn operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLakeFormationOptIn
default CompletableFuture<CreateLakeFormationOptInResponse> createLakeFormationOptIn(Consumer<CreateLakeFormationOptInRequest.Builder> createLakeFormationOptInRequest) Enforce Lake Formation permissions for the given databases, tables, and principals.
This is a convenience which creates an instance of the
CreateLakeFormationOptInRequest.Builderavoiding the need to create one manually viaCreateLakeFormationOptInRequest.builder()- Parameters:
createLakeFormationOptInRequest- AConsumerthat will call methods onCreateLakeFormationOptInRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateLakeFormationOptIn operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataCellsFilter
default CompletableFuture<DeleteDataCellsFilterResponse> deleteDataCellsFilter(DeleteDataCellsFilterRequest deleteDataCellsFilterRequest) Deletes a data cell filter.
- Parameters:
deleteDataCellsFilterRequest-- Returns:
- A Java Future containing the result of the DeleteDataCellsFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataCellsFilter
default CompletableFuture<DeleteDataCellsFilterResponse> deleteDataCellsFilter(Consumer<DeleteDataCellsFilterRequest.Builder> deleteDataCellsFilterRequest) Deletes a data cell filter.
This is a convenience which creates an instance of the
DeleteDataCellsFilterRequest.Builderavoiding the need to create one manually viaDeleteDataCellsFilterRequest.builder()- Parameters:
deleteDataCellsFilterRequest- AConsumerthat will call methods onDeleteDataCellsFilterRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDataCellsFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLFTag
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
LFTagPolicyattached 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:
- A Java Future containing the result of the DeleteLFTag operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLFTag
default CompletableFuture<DeleteLfTagResponse> deleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest) Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the
LFTagPolicyattached 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.Builderavoiding the need to create one manually viaDeleteLfTagRequest.builder()- Parameters:
deleteLfTagRequest- AConsumerthat will call methods onDeleteLfTagRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteLFTag operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLFTagExpression
default CompletableFuture<DeleteLfTagExpressionResponse> deleteLFTagExpression(DeleteLfTagExpressionRequest deleteLfTagExpressionRequest) Deletes the LF-Tag expression. The caller must be a data lake admin or have
DROPpermissions on the LF-Tag expression. Deleting a LF-Tag expression will also delete allLFTagPolicypermissions referencing the LF-Tag expression.- Parameters:
deleteLfTagExpressionRequest-- Returns:
- A Java Future containing the result of the DeleteLFTagExpression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLFTagExpression
default CompletableFuture<DeleteLfTagExpressionResponse> deleteLFTagExpression(Consumer<DeleteLfTagExpressionRequest.Builder> deleteLfTagExpressionRequest) Deletes the LF-Tag expression. The caller must be a data lake admin or have
DROPpermissions on the LF-Tag expression. Deleting a LF-Tag expression will also delete allLFTagPolicypermissions referencing the LF-Tag expression.
This is a convenience which creates an instance of the
DeleteLfTagExpressionRequest.Builderavoiding the need to create one manually viaDeleteLfTagExpressionRequest.builder()- Parameters:
deleteLfTagExpressionRequest- AConsumerthat will call methods onDeleteLfTagExpressionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteLFTagExpression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLakeFormationIdentityCenterConfiguration
default CompletableFuture<DeleteLakeFormationIdentityCenterConfigurationResponse> deleteLakeFormationIdentityCenterConfiguration(DeleteLakeFormationIdentityCenterConfigurationRequest deleteLakeFormationIdentityCenterConfigurationRequest) Deletes an IAM Identity Center connection with Lake Formation.
- Parameters:
deleteLakeFormationIdentityCenterConfigurationRequest-- Returns:
- A Java Future containing the result of the DeleteLakeFormationIdentityCenterConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLakeFormationIdentityCenterConfiguration
default CompletableFuture<DeleteLakeFormationIdentityCenterConfigurationResponse> deleteLakeFormationIdentityCenterConfiguration(Consumer<DeleteLakeFormationIdentityCenterConfigurationRequest.Builder> deleteLakeFormationIdentityCenterConfigurationRequest) Deletes an IAM Identity Center connection with Lake Formation.
This is a convenience which creates an instance of the
DeleteLakeFormationIdentityCenterConfigurationRequest.Builderavoiding the need to create one manually viaDeleteLakeFormationIdentityCenterConfigurationRequest.builder()- Parameters:
deleteLakeFormationIdentityCenterConfigurationRequest- AConsumerthat will call methods onDeleteLakeFormationIdentityCenterConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteLakeFormationIdentityCenterConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLakeFormationOptIn
default CompletableFuture<DeleteLakeFormationOptInResponse> deleteLakeFormationOptIn(DeleteLakeFormationOptInRequest deleteLakeFormationOptInRequest) Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
- Parameters:
deleteLakeFormationOptInRequest-- Returns:
- A Java Future containing the result of the DeleteLakeFormationOptIn operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLakeFormationOptIn
default CompletableFuture<DeleteLakeFormationOptInResponse> deleteLakeFormationOptIn(Consumer<DeleteLakeFormationOptInRequest.Builder> deleteLakeFormationOptInRequest) Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
This is a convenience which creates an instance of the
DeleteLakeFormationOptInRequest.Builderavoiding the need to create one manually viaDeleteLakeFormationOptInRequest.builder()- Parameters:
deleteLakeFormationOptInRequest- AConsumerthat will call methods onDeleteLakeFormationOptInRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteLakeFormationOptIn operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteObjectsOnCancel
default CompletableFuture<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. 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 callDeleteObjectsOnCancelbefore writes. For more information, see Rolling Back Amazon S3 Writes.- Parameters:
deleteObjectsOnCancelRequest-- Returns:
- A Java Future containing the result of the DeleteObjectsOnCancel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- ResourceNotReadyException Contains details about an error related to a resource which is not ready for a transaction.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteObjectsOnCancel
default CompletableFuture<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. 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 callDeleteObjectsOnCancelbefore writes. For more information, see Rolling Back Amazon S3 Writes.
This is a convenience which creates an instance of the
DeleteObjectsOnCancelRequest.Builderavoiding the need to create one manually viaDeleteObjectsOnCancelRequest.builder()- Parameters:
deleteObjectsOnCancelRequest- AConsumerthat will call methods onDeleteObjectsOnCancelRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteObjectsOnCancel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- ResourceNotReadyException Contains details about an error related to a resource which is not ready for a transaction.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterResource
default CompletableFuture<DeregisterResourceResponse> deregisterResource(DeregisterResourceRequest deregisterResourceRequest) Deregisters the resource as managed by the Data Catalog.
When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
- Parameters:
deregisterResourceRequest-- Returns:
- A Java Future containing the result of the DeregisterResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterResource
default CompletableFuture<DeregisterResourceResponse> deregisterResource(Consumer<DeregisterResourceRequest.Builder> deregisterResourceRequest) Deregisters the resource as managed by the Data Catalog.
When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
This is a convenience which creates an instance of the
DeregisterResourceRequest.Builderavoiding the need to create one manually viaDeregisterResourceRequest.builder()- Parameters:
deregisterResourceRequest- AConsumerthat will call methods onDeregisterResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeregisterResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLakeFormationIdentityCenterConfiguration
default CompletableFuture<DescribeLakeFormationIdentityCenterConfigurationResponse> describeLakeFormationIdentityCenterConfiguration(DescribeLakeFormationIdentityCenterConfigurationRequest describeLakeFormationIdentityCenterConfigurationRequest) Retrieves the instance ARN and application ARN for the connection.
- Parameters:
describeLakeFormationIdentityCenterConfigurationRequest-- Returns:
- A Java Future containing the result of the DescribeLakeFormationIdentityCenterConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLakeFormationIdentityCenterConfiguration
default CompletableFuture<DescribeLakeFormationIdentityCenterConfigurationResponse> describeLakeFormationIdentityCenterConfiguration(Consumer<DescribeLakeFormationIdentityCenterConfigurationRequest.Builder> describeLakeFormationIdentityCenterConfigurationRequest) Retrieves the instance ARN and application ARN for the connection.
This is a convenience which creates an instance of the
DescribeLakeFormationIdentityCenterConfigurationRequest.Builderavoiding the need to create one manually viaDescribeLakeFormationIdentityCenterConfigurationRequest.builder()- Parameters:
describeLakeFormationIdentityCenterConfigurationRequest- AConsumerthat will call methods onDescribeLakeFormationIdentityCenterConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeLakeFormationIdentityCenterConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeResource
default CompletableFuture<DescribeResourceResponse> describeResource(DescribeResourceRequest describeResourceRequest) Retrieves the current data access role for the given resource registered in Lake Formation.
- Parameters:
describeResourceRequest-- Returns:
- A Java Future containing the result of the DescribeResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeResource
default CompletableFuture<DescribeResourceResponse> describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) 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.Builderavoiding the need to create one manually viaDescribeResourceRequest.builder()- Parameters:
describeResourceRequest- AConsumerthat will call methods onDescribeResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTransaction
default CompletableFuture<DescribeTransactionResponse> describeTransaction(DescribeTransactionRequest describeTransactionRequest) Returns the details of a single transaction.
- Parameters:
describeTransactionRequest-- Returns:
- A Java Future containing the result of the DescribeTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTransaction
default CompletableFuture<DescribeTransactionResponse> describeTransaction(Consumer<DescribeTransactionRequest.Builder> describeTransactionRequest) Returns the details of a single transaction.
This is a convenience which creates an instance of the
DescribeTransactionRequest.Builderavoiding the need to create one manually viaDescribeTransactionRequest.builder()- Parameters:
describeTransactionRequest- AConsumerthat will call methods onDescribeTransactionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
extendTransaction
default CompletableFuture<ExtendTransactionResponse> extendTransaction(ExtendTransactionRequest extendTransactionRequest) Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.
- Parameters:
extendTransactionRequest-- Returns:
- A Java Future containing the result of the ExtendTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- TransactionCommitInProgressException Contains details about an error related to a transaction commit that was in progress.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
extendTransaction
default CompletableFuture<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.
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.Builderavoiding the need to create one manually viaExtendTransactionRequest.builder()- Parameters:
extendTransactionRequest- AConsumerthat will call methods onExtendTransactionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ExtendTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- TransactionCommitInProgressException Contains details about an error related to a transaction commit that was in progress.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataCellsFilter
default CompletableFuture<GetDataCellsFilterResponse> getDataCellsFilter(GetDataCellsFilterRequest getDataCellsFilterRequest) Returns a data cells filter.
- Parameters:
getDataCellsFilterRequest-- Returns:
- A Java Future containing the result of the GetDataCellsFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataCellsFilter
default CompletableFuture<GetDataCellsFilterResponse> getDataCellsFilter(Consumer<GetDataCellsFilterRequest.Builder> getDataCellsFilterRequest) Returns a data cells filter.
This is a convenience which creates an instance of the
GetDataCellsFilterRequest.Builderavoiding the need to create one manually viaGetDataCellsFilterRequest.builder()- Parameters:
getDataCellsFilterRequest- AConsumerthat will call methods onGetDataCellsFilterRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDataCellsFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataLakePrincipal
default CompletableFuture<GetDataLakePrincipalResponse> getDataLakePrincipal(GetDataLakePrincipalRequest getDataLakePrincipalRequest) Returns the identity of the invoking principal.
- Parameters:
getDataLakePrincipalRequest-- Returns:
- A Java Future containing the result of the GetDataLakePrincipal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataLakePrincipal
default CompletableFuture<GetDataLakePrincipalResponse> getDataLakePrincipal(Consumer<GetDataLakePrincipalRequest.Builder> getDataLakePrincipalRequest) Returns the identity of the invoking principal.
This is a convenience which creates an instance of the
GetDataLakePrincipalRequest.Builderavoiding the need to create one manually viaGetDataLakePrincipalRequest.builder()- Parameters:
getDataLakePrincipalRequest- AConsumerthat will call methods onGetDataLakePrincipalRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDataLakePrincipal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataLakeSettings
default CompletableFuture<GetDataLakeSettingsResponse> getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest) Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
- Parameters:
getDataLakeSettingsRequest-- Returns:
- A Java Future containing the result of the GetDataLakeSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataLakeSettings
default CompletableFuture<GetDataLakeSettingsResponse> getDataLakeSettings(Consumer<GetDataLakeSettingsRequest.Builder> getDataLakeSettingsRequest) 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.Builderavoiding the need to create one manually viaGetDataLakeSettingsRequest.builder()- Parameters:
getDataLakeSettingsRequest- AConsumerthat will call methods onGetDataLakeSettingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDataLakeSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEffectivePermissionsForPath
default CompletableFuture<GetEffectivePermissionsForPathResponse> getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
GetEffectivePermissionsForPathwill not return databases and tables if the catalog is encrypted.- Parameters:
getEffectivePermissionsForPathRequest-- Returns:
- A Java Future containing the result of the GetEffectivePermissionsForPath operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEffectivePermissionsForPath
default CompletableFuture<GetEffectivePermissionsForPathResponse> getEffectivePermissionsForPath(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
GetEffectivePermissionsForPathwill not return databases and tables if the catalog is encrypted.
This is a convenience which creates an instance of the
GetEffectivePermissionsForPathRequest.Builderavoiding the need to create one manually viaGetEffectivePermissionsForPathRequest.builder()- Parameters:
getEffectivePermissionsForPathRequest- AConsumerthat will call methods onGetEffectivePermissionsForPathRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetEffectivePermissionsForPath operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEffectivePermissionsForPathPaginator
default GetEffectivePermissionsForPathPublisher getEffectivePermissionsForPathPaginator(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) This is a variant of
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathPublisher publisher = client.getEffectivePermissionsForPathPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathPublisher publisher = client.getEffectivePermissionsForPathPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEffectivePermissionsForPathPaginator
default GetEffectivePermissionsForPathPublisher getEffectivePermissionsForPathPaginator(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) This is a variant of
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathPublisher publisher = client.getEffectivePermissionsForPathPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathPublisher publisher = client.getEffectivePermissionsForPathPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse response) { //... }; });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.Builderavoiding the need to create one manually viaGetEffectivePermissionsForPathRequest.builder()- Parameters:
getEffectivePermissionsForPathRequest- AConsumerthat will call methods onGetEffectivePermissionsForPathRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLFTag
Returns an LF-tag definition.
- Parameters:
getLfTagRequest-- Returns:
- A Java Future containing the result of the GetLFTag operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLFTag
default CompletableFuture<GetLfTagResponse> getLFTag(Consumer<GetLfTagRequest.Builder> getLfTagRequest) Returns an LF-tag definition.
This is a convenience which creates an instance of the
GetLfTagRequest.Builderavoiding the need to create one manually viaGetLfTagRequest.builder()- Parameters:
getLfTagRequest- AConsumerthat will call methods onGetLfTagRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetLFTag operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLFTagExpression
default CompletableFuture<GetLfTagExpressionResponse> getLFTagExpression(GetLfTagExpressionRequest getLfTagExpressionRequest) Returns the details about the LF-Tag expression. The caller must be a data lake admin or must have
DESCRIBEpermission on the LF-Tag expression resource.- Parameters:
getLfTagExpressionRequest-- Returns:
- A Java Future containing the result of the GetLFTagExpression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getLFTagExpression
default CompletableFuture<GetLfTagExpressionResponse> getLFTagExpression(Consumer<GetLfTagExpressionRequest.Builder> getLfTagExpressionRequest) Returns the details about the LF-Tag expression. The caller must be a data lake admin or must have
DESCRIBEpermission on the LF-Tag expression resource.
This is a convenience which creates an instance of the
GetLfTagExpressionRequest.Builderavoiding the need to create one manually viaGetLfTagExpressionRequest.builder()- Parameters:
getLfTagExpressionRequest- AConsumerthat will call methods onGetLfTagExpressionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetLFTagExpression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryState
default CompletableFuture<GetQueryStateResponse> getQueryState(GetQueryStateRequest getQueryStateRequest) Returns the state of a query previously submitted. Clients are expected to poll
GetQueryStateto 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:
- A Java Future containing the result of the GetQueryState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryState
default CompletableFuture<GetQueryStateResponse> getQueryState(Consumer<GetQueryStateRequest.Builder> getQueryStateRequest) Returns the state of a query previously submitted. Clients are expected to poll
GetQueryStateto 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.Builderavoiding the need to create one manually viaGetQueryStateRequest.builder()- Parameters:
getQueryStateRequest- AConsumerthat will call methods onGetQueryStateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetQueryState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryStatistics
default CompletableFuture<GetQueryStatisticsResponse> getQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest) Retrieves statistics on the planning and execution of a query.
- Parameters:
getQueryStatisticsRequest-- Returns:
- A Java Future containing the result of the GetQueryStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- StatisticsNotReadyYetException Contains details about an error related to statistics not being ready.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ExpiredException Contains details about an error where the query request expired.
- ThrottledException Contains details about an error where the query request was throttled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryStatistics
default CompletableFuture<GetQueryStatisticsResponse> getQueryStatistics(Consumer<GetQueryStatisticsRequest.Builder> getQueryStatisticsRequest) Retrieves statistics on the planning and execution of a query.
This is a convenience which creates an instance of the
GetQueryStatisticsRequest.Builderavoiding the need to create one manually viaGetQueryStatisticsRequest.builder()- Parameters:
getQueryStatisticsRequest- AConsumerthat will call methods onGetQueryStatisticsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetQueryStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- StatisticsNotReadyYetException Contains details about an error related to statistics not being ready.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ExpiredException Contains details about an error where the query request expired.
- ThrottledException Contains details about an error where the query request was throttled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourceLFTags
default CompletableFuture<GetResourceLfTagsResponse> getResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest) Returns the LF-tags applied to a resource.
- Parameters:
getResourceLfTagsRequest-- Returns:
- A Java Future containing the result of the GetResourceLFTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourceLFTags
default CompletableFuture<GetResourceLfTagsResponse> getResourceLFTags(Consumer<GetResourceLfTagsRequest.Builder> getResourceLfTagsRequest) Returns the LF-tags applied to a resource.
This is a convenience which creates an instance of the
GetResourceLfTagsRequest.Builderavoiding the need to create one manually viaGetResourceLfTagsRequest.builder()- Parameters:
getResourceLfTagsRequest- AConsumerthat will call methods onGetResourceLfTagsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetResourceLFTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTableObjects
default CompletableFuture<GetTableObjectsResponse> getTableObjects(GetTableObjectsRequest getTableObjectsRequest) Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
- Parameters:
getTableObjectsRequest-- Returns:
- A Java Future containing the result of the GetTableObjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- ResourceNotReadyException Contains details about an error related to a resource which is not ready for a transaction.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTableObjects
default CompletableFuture<GetTableObjectsResponse> getTableObjects(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
This is a convenience which creates an instance of the
GetTableObjectsRequest.Builderavoiding the need to create one manually viaGetTableObjectsRequest.builder()- Parameters:
getTableObjectsRequest- AConsumerthat will call methods onGetTableObjectsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetTableObjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- ResourceNotReadyException Contains details about an error related to a resource which is not ready for a transaction.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTableObjectsPaginator
default GetTableObjectsPublisher getTableObjectsPaginator(GetTableObjectsRequest getTableObjectsRequest) This is a variant of
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsPublisher publisher = client.getTableObjectsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsPublisher publisher = client.getTableObjectsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- ResourceNotReadyException Contains details about an error related to a resource which is not ready for a transaction.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTableObjectsPaginator
default GetTableObjectsPublisher getTableObjectsPaginator(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) This is a variant of
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsPublisher publisher = client.getTableObjectsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsPublisher publisher = client.getTableObjectsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaGetTableObjectsRequest.builder()- Parameters:
getTableObjectsRequest- AConsumerthat will call methods onGetTableObjectsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- ResourceNotReadyException Contains details about an error related to a resource which is not ready for a transaction.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTemporaryGluePartitionCredentials
default CompletableFuture<GetTemporaryGluePartitionCredentialsResponse> getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest getTemporaryGluePartitionCredentialsRequest) This API is identical to
GetTemporaryTableCredentialsexcept 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:
- A Java Future containing the result of the GetTemporaryGluePartitionCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- AccessDeniedException Access to a resource was denied.
- PermissionTypeMismatchException The engine does not support filtering data based on the enforced
permissions. For example, if you call the
GetTemporaryGlueTableCredentialsoperation withSupportedPermissionTypeequal toColumnPermission, but cell-level permissions exist on the table, this exception is thrown. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTemporaryGluePartitionCredentials
default CompletableFuture<GetTemporaryGluePartitionCredentialsResponse> getTemporaryGluePartitionCredentials(Consumer<GetTemporaryGluePartitionCredentialsRequest.Builder> getTemporaryGluePartitionCredentialsRequest) This API is identical to
GetTemporaryTableCredentialsexcept 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.Builderavoiding the need to create one manually viaGetTemporaryGluePartitionCredentialsRequest.builder()- Parameters:
getTemporaryGluePartitionCredentialsRequest- AConsumerthat will call methods onGetTemporaryGluePartitionCredentialsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetTemporaryGluePartitionCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- AccessDeniedException Access to a resource was denied.
- PermissionTypeMismatchException The engine does not support filtering data based on the enforced
permissions. For example, if you call the
GetTemporaryGlueTableCredentialsoperation withSupportedPermissionTypeequal toColumnPermission, but cell-level permissions exist on the table, this exception is thrown. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTemporaryGlueTableCredentials
default CompletableFuture<GetTemporaryGlueTableCredentialsResponse> getTemporaryGlueTableCredentials(GetTemporaryGlueTableCredentialsRequest getTemporaryGlueTableCredentialsRequest) Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
To call this API, the role that the service assumes must have
lakeformation:GetDataAccesspermission on the resource.- Parameters:
getTemporaryGlueTableCredentialsRequest-- Returns:
- A Java Future containing the result of the GetTemporaryGlueTableCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- AccessDeniedException Access to a resource was denied.
- PermissionTypeMismatchException The engine does not support filtering data based on the enforced
permissions. For example, if you call the
GetTemporaryGlueTableCredentialsoperation withSupportedPermissionTypeequal toColumnPermission, but cell-level permissions exist on the table, this exception is thrown. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTemporaryGlueTableCredentials
default CompletableFuture<GetTemporaryGlueTableCredentialsResponse> getTemporaryGlueTableCredentials(Consumer<GetTemporaryGlueTableCredentialsRequest.Builder> getTemporaryGlueTableCredentialsRequest) Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
To call this API, the role that the service assumes must have
lakeformation:GetDataAccesspermission on the resource.
This is a convenience which creates an instance of the
GetTemporaryGlueTableCredentialsRequest.Builderavoiding the need to create one manually viaGetTemporaryGlueTableCredentialsRequest.builder()- Parameters:
getTemporaryGlueTableCredentialsRequest- AConsumerthat will call methods onGetTemporaryGlueTableCredentialsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetTemporaryGlueTableCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- AccessDeniedException Access to a resource was denied.
- PermissionTypeMismatchException The engine does not support filtering data based on the enforced
permissions. For example, if you call the
GetTemporaryGlueTableCredentialsoperation withSupportedPermissionTypeequal toColumnPermission, but cell-level permissions exist on the table, this exception is thrown. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkUnitResults
default <ReturnT> CompletableFuture<ReturnT> getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, AsyncResponseTransformer<GetWorkUnitResultsResponse, ReturnT> asyncResponseTransformer) Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
- Parameters:
getWorkUnitResultsRequest-asyncResponseTransformer- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformerfor details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'Rows returned from the
'.GetWorkUnitResultsoperation as a stream of Apache Arrow v1.0 messages.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ExpiredException Contains details about an error where the query request expired.
- ThrottledException Contains details about an error where the query request was throttled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkUnitResults
default <ReturnT> CompletableFuture<ReturnT> getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, AsyncResponseTransformer<GetWorkUnitResultsResponse, ReturnT> asyncResponseTransformer) 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.Builderavoiding the need to create one manually viaGetWorkUnitResultsRequest.builder()- Parameters:
getWorkUnitResultsRequest- AConsumerthat will call methods onGetWorkUnitResultsRequest.Builderto create a request.asyncResponseTransformer- The response transformer for processing the streaming response in a non-blocking manner. SeeAsyncResponseTransformerfor details on how this callback should be implemented and for links to precanned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'Rows returned from the
'.GetWorkUnitResultsoperation as a stream of Apache Arrow v1.0 messages.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ExpiredException Contains details about an error where the query request expired.
- ThrottledException Contains details about an error where the query request was throttled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkUnitResults
default CompletableFuture<GetWorkUnitResultsResponse> getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, Path destinationPath) Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
- Parameters:
getWorkUnitResultsRequest-destinationPath-Pathto 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
'.GetWorkUnitResultsoperation as a stream of Apache Arrow v1.0 messages.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ExpiredException Contains details about an error where the query request expired.
- ThrottledException Contains details about an error where the query request was throttled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkUnitResults
default CompletableFuture<GetWorkUnitResultsResponse> getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, Path destinationPath) 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.Builderavoiding the need to create one manually viaGetWorkUnitResultsRequest.builder()- Parameters:
getWorkUnitResultsRequest- AConsumerthat will call methods onGetWorkUnitResultsRequest.Builderto create a request.destinationPath-Pathto 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
'.GetWorkUnitResultsoperation as a stream of Apache Arrow v1.0 messages.- Returns:
- A future to the transformed result of the AsyncResponseTransformer.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ExpiredException Contains details about an error where the query request expired.
- ThrottledException Contains details about an error where the query request was throttled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkUnits
default CompletableFuture<GetWorkUnitsResponse> getWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest) Retrieves the work units generated by the
StartQueryPlanningoperation.- Parameters:
getWorkUnitsRequest-- Returns:
- A Java Future containing the result of the GetWorkUnits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- WorkUnitsNotReadyYetException Contains details about an error related to work units not being ready.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ExpiredException Contains details about an error where the query request expired.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkUnits
default CompletableFuture<GetWorkUnitsResponse> getWorkUnits(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) Retrieves the work units generated by the
StartQueryPlanningoperation.
This is a convenience which creates an instance of the
GetWorkUnitsRequest.Builderavoiding the need to create one manually viaGetWorkUnitsRequest.builder()- Parameters:
getWorkUnitsRequest- AConsumerthat will call methods onGetWorkUnitsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetWorkUnits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- WorkUnitsNotReadyYetException Contains details about an error related to work units not being ready.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ExpiredException Contains details about an error where the query request expired.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkUnitsPaginator
This is a variant of
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsPublisher publisher = client.getWorkUnitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsPublisher publisher = client.getWorkUnitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- WorkUnitsNotReadyYetException Contains details about an error related to work units not being ready.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ExpiredException Contains details about an error where the query request expired.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkUnitsPaginator
default GetWorkUnitsPublisher getWorkUnitsPaginator(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) This is a variant of
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsPublisher publisher = client.getWorkUnitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsPublisher publisher = client.getWorkUnitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaGetWorkUnitsRequest.builder()- Parameters:
getWorkUnitsRequest- AConsumerthat will call methods onGetWorkUnitsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- WorkUnitsNotReadyYetException Contains details about an error related to work units not being ready.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ExpiredException Contains details about an error where the query request expired.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
grantPermissions
default CompletableFuture<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.
For information about permissions, see Security and Access Control to Metadata and Data.
- Parameters:
grantPermissionsRequest-- Returns:
- A Java Future containing the result of the GrantPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
grantPermissions
default CompletableFuture<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.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a convenience which creates an instance of the
GrantPermissionsRequest.Builderavoiding the need to create one manually viaGrantPermissionsRequest.builder()- Parameters:
grantPermissionsRequest- AConsumerthat will call methods onGrantPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GrantPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataCellsFilter
default CompletableFuture<ListDataCellsFilterResponse> listDataCellsFilter(ListDataCellsFilterRequest listDataCellsFilterRequest) Lists all the data cell filters on a table.
- Parameters:
listDataCellsFilterRequest-- Returns:
- A Java Future containing the result of the ListDataCellsFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataCellsFilter
default CompletableFuture<ListDataCellsFilterResponse> listDataCellsFilter(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) Lists all the data cell filters on a table.
This is a convenience which creates an instance of the
ListDataCellsFilterRequest.Builderavoiding the need to create one manually viaListDataCellsFilterRequest.builder()- Parameters:
listDataCellsFilterRequest- AConsumerthat will call methods onListDataCellsFilterRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDataCellsFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataCellsFilterPaginator
default ListDataCellsFilterPublisher listDataCellsFilterPaginator(ListDataCellsFilterRequest listDataCellsFilterRequest) This is a variant of
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterPublisher publisher = client.listDataCellsFilterPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterPublisher publisher = client.listDataCellsFilterPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataCellsFilterPaginator
default ListDataCellsFilterPublisher listDataCellsFilterPaginator(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) This is a variant of
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterPublisher publisher = client.listDataCellsFilterPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterPublisher publisher = client.listDataCellsFilterPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListDataCellsFilterRequest.builder()- Parameters:
listDataCellsFilterRequest- AConsumerthat will call methods onListDataCellsFilterRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLFTagExpressions
default CompletableFuture<ListLfTagExpressionsResponse> listLFTagExpressions(ListLfTagExpressionsRequest listLfTagExpressionsRequest) Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions. Data Lake and read only admins implicitly can see all tag expressions in their account, else caller needs DESCRIBE permissions on tag expression.
- Parameters:
listLfTagExpressionsRequest-- Returns:
- A Java Future containing the result of the ListLFTagExpressions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLFTagExpressions
default CompletableFuture<ListLfTagExpressionsResponse> listLFTagExpressions(Consumer<ListLfTagExpressionsRequest.Builder> listLfTagExpressionsRequest) Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions. Data Lake and read only admins implicitly can see all tag expressions in their account, else caller needs DESCRIBE permissions on tag expression.
This is a convenience which creates an instance of the
ListLfTagExpressionsRequest.Builderavoiding the need to create one manually viaListLfTagExpressionsRequest.builder()- Parameters:
listLfTagExpressionsRequest- AConsumerthat will call methods onListLfTagExpressionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListLFTagExpressions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLFTagExpressionsPaginator
default ListLFTagExpressionsPublisher listLFTagExpressionsPaginator(ListLfTagExpressionsRequest listLfTagExpressionsRequest) This is a variant of
listLFTagExpressions(software.amazon.awssdk.services.lakeformation.model.ListLfTagExpressionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListLFTagExpressionsPublisher publisher = client.listLFTagExpressionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListLFTagExpressionsPublisher publisher = client.listLFTagExpressionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListLfTagExpressionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListLfTagExpressionsResponse response) { //... }; });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
listLFTagExpressions(software.amazon.awssdk.services.lakeformation.model.ListLfTagExpressionsRequest)operation.- Parameters:
listLfTagExpressionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLFTagExpressionsPaginator
default ListLFTagExpressionsPublisher listLFTagExpressionsPaginator(Consumer<ListLfTagExpressionsRequest.Builder> listLfTagExpressionsRequest) This is a variant of
listLFTagExpressions(software.amazon.awssdk.services.lakeformation.model.ListLfTagExpressionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListLFTagExpressionsPublisher publisher = client.listLFTagExpressionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListLFTagExpressionsPublisher publisher = client.listLFTagExpressionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListLfTagExpressionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListLfTagExpressionsResponse response) { //... }; });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
listLFTagExpressions(software.amazon.awssdk.services.lakeformation.model.ListLfTagExpressionsRequest)operation.
This is a convenience which creates an instance of the
ListLfTagExpressionsRequest.Builderavoiding the need to create one manually viaListLfTagExpressionsRequest.builder()- Parameters:
listLfTagExpressionsRequest- AConsumerthat will call methods onListLfTagExpressionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLFTags
Lists LF-tags that the requester has permission to view.
- Parameters:
listLfTagsRequest-- Returns:
- A Java Future containing the result of the ListLFTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLFTags
default CompletableFuture<ListLfTagsResponse> listLFTags(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) Lists LF-tags that the requester has permission to view.
This is a convenience which creates an instance of the
ListLfTagsRequest.Builderavoiding the need to create one manually viaListLfTagsRequest.builder()- Parameters:
listLfTagsRequest- AConsumerthat will call methods onListLfTagsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListLFTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLFTagsPaginator
This is a variant of
listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListLFTagsPublisher publisher = client.listLFTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsPublisher publisher = client.listLFTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLFTagsPaginator
default ListLFTagsPublisher listLFTagsPaginator(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) This is a variant of
listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListLFTagsPublisher publisher = client.listLFTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsPublisher publisher = client.listLFTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListLfTagsRequest.builder()- Parameters:
listLfTagsRequest- AConsumerthat will call methods onListLfTagsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLakeFormationOptIns
default CompletableFuture<ListLakeFormationOptInsResponse> listLakeFormationOptIns(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
- Parameters:
listLakeFormationOptInsRequest-- Returns:
- A Java Future containing the result of the ListLakeFormationOptIns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLakeFormationOptIns
default CompletableFuture<ListLakeFormationOptInsResponse> listLakeFormationOptIns(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) 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.Builderavoiding the need to create one manually viaListLakeFormationOptInsRequest.builder()- Parameters:
listLakeFormationOptInsRequest- AConsumerthat will call methods onListLakeFormationOptInsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListLakeFormationOptIns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLakeFormationOptInsPaginator
default ListLakeFormationOptInsPublisher listLakeFormationOptInsPaginator(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) This is a variant of
listLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsPublisher publisher = client.listLakeFormationOptInsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsPublisher publisher = client.listLakeFormationOptInsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLakeFormationOptInsPaginator
default ListLakeFormationOptInsPublisher listLakeFormationOptInsPaginator(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) This is a variant of
listLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsPublisher publisher = client.listLakeFormationOptInsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsPublisher publisher = client.listLakeFormationOptInsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListLakeFormationOptInsRequest.builder()- Parameters:
listLakeFormationOptInsRequest- AConsumerthat will call methods onListLakeFormationOptInsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissions
default CompletableFuture<ListPermissionsResponse> listPermissions(ListPermissionsRequest listPermissionsRequest) Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
- Parameters:
listPermissionsRequest-- Returns:
- A Java Future containing the result of the ListPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissions
default CompletableFuture<ListPermissionsResponse> listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builderavoiding the need to create one manually viaListPermissionsRequest.builder()- Parameters:
listPermissionsRequest- AConsumerthat will call methods onListPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionsPaginator
default ListPermissionsPublisher listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) This is a variant of
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionsPaginator
default ListPermissionsPublisher listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) This is a variant of
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListPermissionsRequest.builder()- Parameters:
listPermissionsRequest- AConsumerthat will call methods onListPermissionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResources
default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest) Lists the resources registered to be managed by the Data Catalog.
- Parameters:
listResourcesRequest-- Returns:
- A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResources
default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Lists the resources registered to be managed by the Data Catalog.
This is a convenience which creates an instance of the
ListResourcesRequest.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcesPaginator
This is a variant of
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcesPaginator
default ListResourcesPublisher listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant of
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTableStorageOptimizers
default CompletableFuture<ListTableStorageOptimizersResponse> listTableStorageOptimizers(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) Returns the configuration of all storage optimizers associated with a specified table.
- Parameters:
listTableStorageOptimizersRequest-- Returns:
- A Java Future containing the result of the ListTableStorageOptimizers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTableStorageOptimizers
default CompletableFuture<ListTableStorageOptimizersResponse> listTableStorageOptimizers(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) Returns the configuration of all storage optimizers associated with a specified table.
This is a convenience which creates an instance of the
ListTableStorageOptimizersRequest.Builderavoiding the need to create one manually viaListTableStorageOptimizersRequest.builder()- Parameters:
listTableStorageOptimizersRequest- AConsumerthat will call methods onListTableStorageOptimizersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTableStorageOptimizers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTableStorageOptimizersPaginator
default ListTableStorageOptimizersPublisher listTableStorageOptimizersPaginator(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) This is a variant of
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersPublisher publisher = client.listTableStorageOptimizersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersPublisher publisher = client.listTableStorageOptimizersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTableStorageOptimizersPaginator
default ListTableStorageOptimizersPublisher listTableStorageOptimizersPaginator(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) This is a variant of
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersPublisher publisher = client.listTableStorageOptimizersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersPublisher publisher = client.listTableStorageOptimizersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListTableStorageOptimizersRequest.builder()- Parameters:
listTableStorageOptimizersRequest- AConsumerthat will call methods onListTableStorageOptimizersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTransactions
default CompletableFuture<ListTransactionsResponse> listTransactions(ListTransactionsRequest listTransactionsRequest) Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
This operation can help you identify uncommitted transactions or to get information about transactions.
- Parameters:
listTransactionsRequest-- Returns:
- A Java Future containing the result of the ListTransactions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTransactions
default CompletableFuture<ListTransactionsResponse> listTransactions(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
This operation can help you identify uncommitted transactions or to get information about transactions.
This is a convenience which creates an instance of the
ListTransactionsRequest.Builderavoiding the need to create one manually viaListTransactionsRequest.builder()- Parameters:
listTransactionsRequest- AConsumerthat will call methods onListTransactionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTransactions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTransactionsPaginator
default ListTransactionsPublisher listTransactionsPaginator(ListTransactionsRequest listTransactionsRequest) This is a variant of
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListTransactionsPublisher publisher = client.listTransactionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsPublisher publisher = client.listTransactionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTransactionsPaginator
default ListTransactionsPublisher listTransactionsPaginator(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) This is a variant of
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.ListTransactionsPublisher publisher = client.listTransactionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsPublisher publisher = client.listTransactionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListTransactionsRequest.builder()- Parameters:
listTransactionsRequest- AConsumerthat will call methods onListTransactionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDataLakeSettings
default CompletableFuture<PutDataLakeSettingsResponse> putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest) Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
- Parameters:
putDataLakeSettingsRequest-- Returns:
- A Java Future containing the result of the PutDataLakeSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDataLakeSettings
default CompletableFuture<PutDataLakeSettingsResponse> putDataLakeSettings(Consumer<PutDataLakeSettingsRequest.Builder> putDataLakeSettingsRequest) Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
This is a convenience which creates an instance of the
PutDataLakeSettingsRequest.Builderavoiding the need to create one manually viaPutDataLakeSettingsRequest.builder()- Parameters:
putDataLakeSettingsRequest- AConsumerthat will call methods onPutDataLakeSettingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutDataLakeSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerResource
default CompletableFuture<RegisterResourceResponse> registerResource(RegisterResourceRequest registerResourceRequest) Registers the resource as managed by the Data Catalog.
To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
ResourceArn = arn:aws:s3:::my-bucket/ UseServiceLinkedRole = trueIf
UseServiceLinkedRoleis not set to true, you must provide or set theRoleArn:arn:aws:iam::12345:role/my-data-access-role- Parameters:
registerResourceRequest-- Returns:
- A Java Future containing the result of the RegisterResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AlreadyExistsException A resource to be created or added already exists.
- EntityNotFoundException A specified entity does not exist.
- ResourceNumberLimitExceededException A resource numerical limit was exceeded.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerResource
default CompletableFuture<RegisterResourceResponse> registerResource(Consumer<RegisterResourceRequest.Builder> registerResourceRequest) Registers the resource as managed by the Data Catalog.
To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
ResourceArn = arn:aws:s3:::my-bucket/ UseServiceLinkedRole = trueIf
UseServiceLinkedRoleis 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.Builderavoiding the need to create one manually viaRegisterResourceRequest.builder()- Parameters:
registerResourceRequest- AConsumerthat will call methods onRegisterResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RegisterResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AlreadyExistsException A resource to be created or added already exists.
- EntityNotFoundException A specified entity does not exist.
- ResourceNumberLimitExceededException A resource numerical limit was exceeded.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeLFTagsFromResource
default CompletableFuture<RemoveLfTagsFromResourceResponse> removeLFTagsFromResource(RemoveLfTagsFromResourceRequest removeLfTagsFromResourceRequest) Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in
tableWithColumnsto specify column input.- Parameters:
removeLfTagsFromResourceRequest-- Returns:
- A Java Future containing the result of the RemoveLFTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeLFTagsFromResource
default CompletableFuture<RemoveLfTagsFromResourceResponse> removeLFTagsFromResource(Consumer<RemoveLfTagsFromResourceRequest.Builder> removeLfTagsFromResourceRequest) Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in
tableWithColumnsto specify column input.
This is a convenience which creates an instance of the
RemoveLfTagsFromResourceRequest.Builderavoiding the need to create one manually viaRemoveLfTagsFromResourceRequest.builder()- Parameters:
removeLfTagsFromResourceRequest- AConsumerthat will call methods onRemoveLfTagsFromResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RemoveLFTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
revokePermissions
default CompletableFuture<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.
- Parameters:
revokePermissionsRequest-- Returns:
- A Java Future containing the result of the RevokePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
revokePermissions
default CompletableFuture<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.
This is a convenience which creates an instance of the
RevokePermissionsRequest.Builderavoiding the need to create one manually viaRevokePermissionsRequest.builder()- Parameters:
revokePermissionsRequest- AConsumerthat will call methods onRevokePermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RevokePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDatabasesByLFTags
default CompletableFuture<SearchDatabasesByLfTagsResponse> searchDatabasesByLFTags(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) This operation allows a search on
DATABASEresources byTagCondition. This operation is used by admins who want to grant user permissions on certainTagConditions. Before making a grant, the admin can useSearchDatabasesByTagsto find all resources where the givenTagConditionsare valid to verify whether the returned resources can be shared.- Parameters:
searchDatabasesByLfTagsRequest-- Returns:
- A Java Future containing the result of the SearchDatabasesByLFTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDatabasesByLFTags
default CompletableFuture<SearchDatabasesByLfTagsResponse> searchDatabasesByLFTags(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) This operation allows a search on
DATABASEresources byTagCondition. This operation is used by admins who want to grant user permissions on certainTagConditions. Before making a grant, the admin can useSearchDatabasesByTagsto find all resources where the givenTagConditionsare valid to verify whether the returned resources can be shared.
This is a convenience which creates an instance of the
SearchDatabasesByLfTagsRequest.Builderavoiding the need to create one manually viaSearchDatabasesByLfTagsRequest.builder()- Parameters:
searchDatabasesByLfTagsRequest- AConsumerthat will call methods onSearchDatabasesByLfTagsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchDatabasesByLFTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDatabasesByLFTagsPaginator
default SearchDatabasesByLFTagsPublisher searchDatabasesByLFTagsPaginator(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) This is a variant of
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsPublisher publisher = client.searchDatabasesByLFTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsPublisher publisher = client.searchDatabasesByLFTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDatabasesByLFTagsPaginator
default SearchDatabasesByLFTagsPublisher searchDatabasesByLFTagsPaginator(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) This is a variant of
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsPublisher publisher = client.searchDatabasesByLFTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsPublisher publisher = client.searchDatabasesByLFTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaSearchDatabasesByLfTagsRequest.builder()- Parameters:
searchDatabasesByLfTagsRequest- AConsumerthat will call methods onSearchDatabasesByLfTagsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchTablesByLFTags
default CompletableFuture<SearchTablesByLfTagsResponse> searchTablesByLFTags(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) This operation allows a search on
TABLEresources byLFTags. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can useSearchTablesByLFTagsto find all resources where the givenLFTags are valid to verify whether the returned resources can be shared.- Parameters:
searchTablesByLfTagsRequest-- Returns:
- A Java Future containing the result of the SearchTablesByLFTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchTablesByLFTags
default CompletableFuture<SearchTablesByLfTagsResponse> searchTablesByLFTags(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) This operation allows a search on
TABLEresources byLFTags. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can useSearchTablesByLFTagsto find all resources where the givenLFTags are valid to verify whether the returned resources can be shared.
This is a convenience which creates an instance of the
SearchTablesByLfTagsRequest.Builderavoiding the need to create one manually viaSearchTablesByLfTagsRequest.builder()- Parameters:
searchTablesByLfTagsRequest- AConsumerthat will call methods onSearchTablesByLfTagsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchTablesByLFTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchTablesByLFTagsPaginator
default SearchTablesByLFTagsPublisher searchTablesByLFTagsPaginator(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) This is a variant of
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsPublisher publisher = client.searchTablesByLFTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsPublisher publisher = client.searchTablesByLFTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchTablesByLFTagsPaginator
default SearchTablesByLFTagsPublisher searchTablesByLFTagsPaginator(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) This is a variant of
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsPublisher publisher = client.searchTablesByLFTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsPublisher publisher = client.searchTablesByLFTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaSearchTablesByLfTagsRequest.builder()- Parameters:
searchTablesByLfTagsRequest- AConsumerthat will call methods onSearchTablesByLfTagsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- GlueEncryptionException An encryption operation failed.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startQueryPlanning
default CompletableFuture<StartQueryPlanningResponse> startQueryPlanning(StartQueryPlanningRequest startQueryPlanningRequest) Submits a request to process a query statement.
This operation generates work units that can be retrieved with the
GetWorkUnitsoperation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.- Parameters:
startQueryPlanningRequest-- Returns:
- A Java Future containing the result of the StartQueryPlanning operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ThrottledException Contains details about an error where the query request was throttled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startQueryPlanning
default CompletableFuture<StartQueryPlanningResponse> startQueryPlanning(Consumer<StartQueryPlanningRequest.Builder> startQueryPlanningRequest) Submits a request to process a query statement.
This operation generates work units that can be retrieved with the
GetWorkUnitsoperation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.
This is a convenience which creates an instance of the
StartQueryPlanningRequest.Builderavoiding the need to create one manually viaStartQueryPlanningRequest.builder()- Parameters:
startQueryPlanningRequest- AConsumerthat will call methods onStartQueryPlanningRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartQueryPlanning operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- ThrottledException Contains details about an error where the query request was throttled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTransaction
default CompletableFuture<StartTransactionResponse> startTransaction(StartTransactionRequest startTransactionRequest) Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
- Parameters:
startTransactionRequest-- Returns:
- A Java Future containing the result of the StartTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTransaction
default CompletableFuture<StartTransactionResponse> startTransaction(Consumer<StartTransactionRequest.Builder> startTransactionRequest) 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.Builderavoiding the need to create one manually viaStartTransactionRequest.builder()- Parameters:
startTransactionRequest- AConsumerthat will call methods onStartTransactionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartTransaction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataCellsFilter
default CompletableFuture<UpdateDataCellsFilterResponse> updateDataCellsFilter(UpdateDataCellsFilterRequest updateDataCellsFilterRequest) Updates a data cell filter.
- Parameters:
updateDataCellsFilterRequest-- Returns:
- A Java Future containing the result of the UpdateDataCellsFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataCellsFilter
default CompletableFuture<UpdateDataCellsFilterResponse> updateDataCellsFilter(Consumer<UpdateDataCellsFilterRequest.Builder> updateDataCellsFilterRequest) Updates a data cell filter.
This is a convenience which creates an instance of the
UpdateDataCellsFilterRequest.Builderavoiding the need to create one manually viaUpdateDataCellsFilterRequest.builder()- Parameters:
updateDataCellsFilterRequest- AConsumerthat will call methods onUpdateDataCellsFilterRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDataCellsFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLFTag
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:
- A Java Future containing the result of the UpdateLFTag operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLFTag
default CompletableFuture<UpdateLfTagResponse> updateLFTag(Consumer<UpdateLfTagRequest.Builder> updateLfTagRequest) Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.
This is a convenience which creates an instance of the
UpdateLfTagRequest.Builderavoiding the need to create one manually viaUpdateLfTagRequest.builder()- Parameters:
updateLfTagRequest- AConsumerthat will call methods onUpdateLfTagRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateLFTag operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLFTagExpression
default CompletableFuture<UpdateLfTagExpressionResponse> updateLFTagExpression(UpdateLfTagExpressionRequest updateLfTagExpressionRequest) Updates the name of the LF-Tag expression to the new description and expression body provided. Updating a LF-Tag expression immediately changes the permission boundaries of all existing
LFTagPolicypermission grants that reference the given LF-Tag expression.- Parameters:
updateLfTagExpressionRequest-- Returns:
- A Java Future containing the result of the UpdateLFTagExpression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- ResourceNumberLimitExceededException A resource numerical limit was exceeded.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLFTagExpression
default CompletableFuture<UpdateLfTagExpressionResponse> updateLFTagExpression(Consumer<UpdateLfTagExpressionRequest.Builder> updateLfTagExpressionRequest) Updates the name of the LF-Tag expression to the new description and expression body provided. Updating a LF-Tag expression immediately changes the permission boundaries of all existing
LFTagPolicypermission grants that reference the given LF-Tag expression.
This is a convenience which creates an instance of the
UpdateLfTagExpressionRequest.Builderavoiding the need to create one manually viaUpdateLfTagExpressionRequest.builder()- Parameters:
updateLfTagExpressionRequest- AConsumerthat will call methods onUpdateLfTagExpressionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateLFTagExpression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- ResourceNumberLimitExceededException A resource numerical limit was exceeded.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLakeFormationIdentityCenterConfiguration
default CompletableFuture<UpdateLakeFormationIdentityCenterConfigurationResponse> updateLakeFormationIdentityCenterConfiguration(UpdateLakeFormationIdentityCenterConfigurationRequest updateLakeFormationIdentityCenterConfigurationRequest) Updates the IAM Identity Center connection parameters.
- Parameters:
updateLakeFormationIdentityCenterConfigurationRequest-- Returns:
- A Java Future containing the result of the UpdateLakeFormationIdentityCenterConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateLakeFormationIdentityCenterConfiguration
default CompletableFuture<UpdateLakeFormationIdentityCenterConfigurationResponse> updateLakeFormationIdentityCenterConfiguration(Consumer<UpdateLakeFormationIdentityCenterConfigurationRequest.Builder> updateLakeFormationIdentityCenterConfigurationRequest) Updates the IAM Identity Center connection parameters.
This is a convenience which creates an instance of the
UpdateLakeFormationIdentityCenterConfigurationRequest.Builderavoiding the need to create one manually viaUpdateLakeFormationIdentityCenterConfigurationRequest.builder()- Parameters:
updateLakeFormationIdentityCenterConfigurationRequest- AConsumerthat will call methods onUpdateLakeFormationIdentityCenterConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateLakeFormationIdentityCenterConfiguration operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- EntityNotFoundException A specified entity does not exist.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- AccessDeniedException Access to a resource was denied.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateResource
default CompletableFuture<UpdateResourceResponse> updateResource(UpdateResourceRequest updateResourceRequest) Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
- Parameters:
updateResourceRequest-- Returns:
- A Java Future containing the result of the UpdateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateResource
default CompletableFuture<UpdateResourceResponse> updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) 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.Builderavoiding the need to create one manually viaUpdateResourceRequest.builder()- Parameters:
updateResourceRequest- AConsumerthat will call methods onUpdateResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input provided was not valid.
- InternalServiceException An internal service error occurred.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTableObjects
default CompletableFuture<UpdateTableObjectsResponse> updateTableObjects(UpdateTableObjectsRequest updateTableObjectsRequest) Updates the manifest of Amazon S3 objects that make up the specified governed table.
- Parameters:
updateTableObjectsRequest-- Returns:
- A Java Future containing the result of the UpdateTableObjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- TransactionCommitInProgressException Contains details about an error related to a transaction commit that was in progress.
- ResourceNotReadyException Contains details about an error related to a resource which is not ready for a transaction.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTableObjects
default CompletableFuture<UpdateTableObjectsResponse> updateTableObjects(Consumer<UpdateTableObjectsRequest.Builder> updateTableObjectsRequest) 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.Builderavoiding the need to create one manually viaUpdateTableObjectsRequest.builder()- Parameters:
updateTableObjectsRequest- AConsumerthat will call methods onUpdateTableObjectsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTableObjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServiceException An internal service error occurred.
- InvalidInputException The input provided was not valid.
- OperationTimeoutException The operation timed out.
- EntityNotFoundException A specified entity does not exist.
- TransactionCommittedException Contains details about an error where the specified transaction has
already been committed and cannot be used for
UpdateTableObjects. - TransactionCanceledException Contains details about an error related to a transaction that was cancelled.
- TransactionCommitInProgressException Contains details about an error related to a transaction commit that was in progress.
- ResourceNotReadyException Contains details about an error related to a resource which is not ready for a transaction.
- ConcurrentModificationException Two processes are trying to modify a resource simultaneously.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTableStorageOptimizer
default CompletableFuture<UpdateTableStorageOptimizerResponse> updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest updateTableStorageOptimizerRequest) Updates the configuration of the storage optimizers for a table.
- Parameters:
updateTableStorageOptimizerRequest-- Returns:
- A Java Future containing the result of the UpdateTableStorageOptimizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTableStorageOptimizer
default CompletableFuture<UpdateTableStorageOptimizerResponse> updateTableStorageOptimizer(Consumer<UpdateTableStorageOptimizerRequest.Builder> updateTableStorageOptimizerRequest) Updates the configuration of the storage optimizers for a table.
This is a convenience which creates an instance of the
UpdateTableStorageOptimizerRequest.Builderavoiding the need to create one manually viaUpdateTableStorageOptimizerRequest.builder()- Parameters:
updateTableStorageOptimizerRequest- AConsumerthat will call methods onUpdateTableStorageOptimizerRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTableStorageOptimizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- EntityNotFoundException A specified entity does not exist.
- InvalidInputException The input provided was not valid.
- AccessDeniedException Access to a resource was denied.
- InternalServiceException An internal service error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- LakeFormationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aLakeFormationAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aLakeFormationAsyncClient.
-