Interface LakeFormationClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
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 TypeMethodDescriptiondefault AddLfTagsToResourceResponseaddLFTagsToResource(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest) Attaches one or more LF-tags to an existing resource.default AddLfTagsToResourceResponseaddLFTagsToResource(AddLfTagsToResourceRequest addLfTagsToResourceRequest) Attaches one or more LF-tags to an existing resource.assumeDecoratedRoleWithSAML(Consumer<AssumeDecoratedRoleWithSamlRequest.Builder> assumeDecoratedRoleWithSamlRequest) Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request.assumeDecoratedRoleWithSAML(AssumeDecoratedRoleWithSamlRequest assumeDecoratedRoleWithSamlRequest) Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request.default BatchGrantPermissionsResponsebatchGrantPermissions(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest) Batch operation to grant permissions to the principal.default BatchGrantPermissionsResponsebatchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest) Batch operation to grant permissions to the principal.default BatchRevokePermissionsResponsebatchRevokePermissions(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest) Batch operation to revoke permissions from the principal.default BatchRevokePermissionsResponsebatchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest) Batch operation to revoke permissions from the principal.static LakeFormationClientBuilderbuilder()Create a builder that can be used to configure and create aLakeFormationClient.default CancelTransactionResponsecancelTransaction(Consumer<CancelTransactionRequest.Builder> cancelTransactionRequest) Attempts to cancel the specified transaction.default CancelTransactionResponsecancelTransaction(CancelTransactionRequest cancelTransactionRequest) Attempts to cancel the specified transaction.default CommitTransactionResponsecommitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest) Attempts to commit the specified transaction.default CommitTransactionResponsecommitTransaction(CommitTransactionRequest commitTransactionRequest) Attempts to commit the specified transaction.static LakeFormationClientcreate()Create aLakeFormationClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateDataCellsFilterResponsecreateDataCellsFilter(Consumer<CreateDataCellsFilterRequest.Builder> createDataCellsFilterRequest) Creates a data cell filter to allow one to grant access to certain columns on certain rows.default CreateDataCellsFilterResponsecreateDataCellsFilter(CreateDataCellsFilterRequest createDataCellsFilterRequest) Creates a data cell filter to allow one to grant access to certain columns on certain rows.createLakeFormationIdentityCenterConfiguration(Consumer<CreateLakeFormationIdentityCenterConfigurationRequest.Builder> createLakeFormationIdentityCenterConfigurationRequest) Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.createLakeFormationIdentityCenterConfiguration(CreateLakeFormationIdentityCenterConfigurationRequest createLakeFormationIdentityCenterConfigurationRequest) Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.default CreateLakeFormationOptInResponsecreateLakeFormationOptIn(Consumer<CreateLakeFormationOptInRequest.Builder> createLakeFormationOptInRequest) Enforce Lake Formation permissions for the given databases, tables, and principals.default CreateLakeFormationOptInResponsecreateLakeFormationOptIn(CreateLakeFormationOptInRequest createLakeFormationOptInRequest) Enforce Lake Formation permissions for the given databases, tables, and principals.default CreateLfTagResponsecreateLFTag(Consumer<CreateLfTagRequest.Builder> createLfTagRequest) Creates an LF-tag with the specified name and values.default CreateLfTagResponsecreateLFTag(CreateLfTagRequest createLfTagRequest) Creates an LF-tag with the specified name and values.default DeleteDataCellsFilterResponsedeleteDataCellsFilter(Consumer<DeleteDataCellsFilterRequest.Builder> deleteDataCellsFilterRequest) Deletes a data cell filter.default DeleteDataCellsFilterResponsedeleteDataCellsFilter(DeleteDataCellsFilterRequest deleteDataCellsFilterRequest) Deletes a data cell filter.deleteLakeFormationIdentityCenterConfiguration(Consumer<DeleteLakeFormationIdentityCenterConfigurationRequest.Builder> deleteLakeFormationIdentityCenterConfigurationRequest) Deletes an IAM Identity Center connection with Lake Formation.deleteLakeFormationIdentityCenterConfiguration(DeleteLakeFormationIdentityCenterConfigurationRequest deleteLakeFormationIdentityCenterConfigurationRequest) Deletes an IAM Identity Center connection with Lake Formation.default DeleteLakeFormationOptInResponsedeleteLakeFormationOptIn(Consumer<DeleteLakeFormationOptInRequest.Builder> deleteLakeFormationOptInRequest) Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.default DeleteLakeFormationOptInResponsedeleteLakeFormationOptIn(DeleteLakeFormationOptInRequest deleteLakeFormationOptInRequest) Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.default DeleteLfTagResponsedeleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest) Deletes the specified LF-tag given a key name.default DeleteLfTagResponsedeleteLFTag(DeleteLfTagRequest deleteLfTagRequest) Deletes the specified LF-tag given a key name.default DeleteObjectsOnCancelResponsedeleteObjectsOnCancel(Consumer<DeleteObjectsOnCancelRequest.Builder> deleteObjectsOnCancelRequest) For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled.default DeleteObjectsOnCancelResponsedeleteObjectsOnCancel(DeleteObjectsOnCancelRequest deleteObjectsOnCancelRequest) For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled.default DeregisterResourceResponsederegisterResource(Consumer<DeregisterResourceRequest.Builder> deregisterResourceRequest) Deregisters the resource as managed by the Data Catalog.default DeregisterResourceResponsederegisterResource(DeregisterResourceRequest deregisterResourceRequest) Deregisters the resource as managed by the Data Catalog.describeLakeFormationIdentityCenterConfiguration(Consumer<DescribeLakeFormationIdentityCenterConfigurationRequest.Builder> describeLakeFormationIdentityCenterConfigurationRequest) Retrieves the instance ARN and application ARN for the connection.describeLakeFormationIdentityCenterConfiguration(DescribeLakeFormationIdentityCenterConfigurationRequest describeLakeFormationIdentityCenterConfigurationRequest) Retrieves the instance ARN and application ARN for the connection.default DescribeResourceResponsedescribeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) Retrieves the current data access role for the given resource registered in Lake Formation.default DescribeResourceResponsedescribeResource(DescribeResourceRequest describeResourceRequest) Retrieves the current data access role for the given resource registered in Lake Formation.default DescribeTransactionResponsedescribeTransaction(Consumer<DescribeTransactionRequest.Builder> describeTransactionRequest) Returns the details of a single transaction.default DescribeTransactionResponsedescribeTransaction(DescribeTransactionRequest describeTransactionRequest) Returns the details of a single transaction.default ExtendTransactionResponseextendTransaction(Consumer<ExtendTransactionRequest.Builder> extendTransactionRequest) Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.default ExtendTransactionResponseextendTransaction(ExtendTransactionRequest extendTransactionRequest) Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.default GetDataCellsFilterResponsegetDataCellsFilter(Consumer<GetDataCellsFilterRequest.Builder> getDataCellsFilterRequest) Returns a data cells filter.default GetDataCellsFilterResponsegetDataCellsFilter(GetDataCellsFilterRequest getDataCellsFilterRequest) Returns a data cells filter.default GetDataLakePrincipalResponsegetDataLakePrincipal(Consumer<GetDataLakePrincipalRequest.Builder> getDataLakePrincipalRequest) Returns the identity of the invoking principal.default GetDataLakePrincipalResponsegetDataLakePrincipal(GetDataLakePrincipalRequest getDataLakePrincipalRequest) Returns the identity of the invoking principal.default GetDataLakeSettingsResponsegetDataLakeSettings(Consumer<GetDataLakeSettingsRequest.Builder> getDataLakeSettingsRequest) Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.default GetDataLakeSettingsResponsegetDataLakeSettings(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 GetLfTagResponsegetLFTag(Consumer<GetLfTagRequest.Builder> getLfTagRequest) Returns an LF-tag definition.default GetLfTagResponsegetLFTag(GetLfTagRequest getLfTagRequest) Returns an LF-tag definition.default GetQueryStateResponsegetQueryState(Consumer<GetQueryStateRequest.Builder> getQueryStateRequest) Returns the state of a query previously submitted.default GetQueryStateResponsegetQueryState(GetQueryStateRequest getQueryStateRequest) Returns the state of a query previously submitted.default GetQueryStatisticsResponsegetQueryStatistics(Consumer<GetQueryStatisticsRequest.Builder> getQueryStatisticsRequest) Retrieves statistics on the planning and execution of a query.default GetQueryStatisticsResponsegetQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest) Retrieves statistics on the planning and execution of a query.default GetResourceLfTagsResponsegetResourceLFTags(Consumer<GetResourceLfTagsRequest.Builder> getResourceLfTagsRequest) Returns the LF-tags applied to a resource.default GetResourceLfTagsResponsegetResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest) Returns the LF-tags applied to a resource.default GetTableObjectsResponsegetTableObjects(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) Returns the set of Amazon S3 objects that make up the specified governed table.default GetTableObjectsResponsegetTableObjects(GetTableObjectsRequest getTableObjectsRequest) Returns the set of Amazon S3 objects that make up the specified governed table.default GetTableObjectsIterablegetTableObjectsPaginator(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) This is a variant ofgetTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)operation.default GetTableObjectsIterablegetTableObjectsPaginator(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) Returns the work units resulting from the query.default GetWorkUnitResultsResponsegetWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, Path destinationPath) Returns the work units resulting from the query.default <ReturnT> ReturnTgetWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, ResponseTransformer<GetWorkUnitResultsResponse, ReturnT> responseTransformer) Returns the work units resulting from the query.getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest) Returns the work units resulting from the query.default GetWorkUnitResultsResponsegetWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, Path destinationPath) Returns the work units resulting from the query.default <ReturnT> ReturnTgetWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, ResponseTransformer<GetWorkUnitResultsResponse, ReturnT> responseTransformer) Returns the work units resulting from the query.default ResponseBytes<GetWorkUnitResultsResponse> getWorkUnitResultsAsBytes(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest) Returns the work units resulting from the query.default ResponseBytes<GetWorkUnitResultsResponse> getWorkUnitResultsAsBytes(GetWorkUnitResultsRequest getWorkUnitResultsRequest) Returns the work units resulting from the query.default GetWorkUnitsResponsegetWorkUnits(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) Retrieves the work units generated by theStartQueryPlanningoperation.default GetWorkUnitsResponsegetWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest) Retrieves the work units generated by theStartQueryPlanningoperation.default GetWorkUnitsIterablegetWorkUnitsPaginator(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) This is a variant ofgetWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)operation.default GetWorkUnitsIterablegetWorkUnitsPaginator(GetWorkUnitsRequest getWorkUnitsRequest) This is a variant ofgetWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)operation.default GrantPermissionsResponsegrantPermissions(Consumer<GrantPermissionsRequest.Builder> grantPermissionsRequest) Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.default GrantPermissionsResponsegrantPermissions(GrantPermissionsRequest grantPermissionsRequest) Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.default ListDataCellsFilterResponselistDataCellsFilter(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) Lists all the data cell filters on a table.default ListDataCellsFilterResponselistDataCellsFilter(ListDataCellsFilterRequest listDataCellsFilterRequest) Lists all the data cell filters on a table.default ListDataCellsFilterIterablelistDataCellsFilterPaginator(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) This is a variant oflistDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)operation.default ListDataCellsFilterIterablelistDataCellsFilterPaginator(ListDataCellsFilterRequest listDataCellsFilterRequest) This is a variant oflistDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)operation.default ListLakeFormationOptInsResponselistLakeFormationOptIns(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.default ListLakeFormationOptInsResponselistLakeFormationOptIns(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.default ListLakeFormationOptInsIterablelistLakeFormationOptInsPaginator(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) This is a variant oflistLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)operation.default ListLakeFormationOptInsIterablelistLakeFormationOptInsPaginator(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) This is a variant oflistLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)operation.default ListLfTagsResponselistLFTags(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) Lists LF-tags that the requester has permission to view.default ListLfTagsResponselistLFTags(ListLfTagsRequest listLfTagsRequest) Lists LF-tags that the requester has permission to view.default ListLFTagsIterablelistLFTagsPaginator(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) This is a variant oflistLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)operation.default ListLFTagsIterablelistLFTagsPaginator(ListLfTagsRequest listLfTagsRequest) This is a variant oflistLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)operation.default ListPermissionsResponselistPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.default ListPermissionsResponselistPermissions(ListPermissionsRequest listPermissionsRequest) Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.default ListPermissionsIterablelistPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)operation.default ListPermissionsIterablelistPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)operation.default ListResourcesResponselistResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Lists the resources registered to be managed by the Data Catalog.default ListResourcesResponselistResources(ListResourcesRequest listResourcesRequest) Lists the resources registered to be managed by the Data Catalog.default ListResourcesIterablelistResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)operation.default ListResourcesIterablelistResourcesPaginator(ListResourcesRequest listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)operation.listTableStorageOptimizers(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) Returns the configuration of all storage optimizers associated with a specified table.listTableStorageOptimizers(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) Returns the configuration of all storage optimizers associated with a specified table.listTableStorageOptimizersPaginator(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) This is a variant oflistTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)operation.listTableStorageOptimizersPaginator(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) This is a variant oflistTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)operation.default ListTransactionsResponselistTransactions(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) Returns metadata about transactions and their status.default ListTransactionsResponselistTransactions(ListTransactionsRequest listTransactionsRequest) Returns metadata about transactions and their status.default ListTransactionsIterablelistTransactionsPaginator(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) This is a variant oflistTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)operation.default ListTransactionsIterablelistTransactionsPaginator(ListTransactionsRequest listTransactionsRequest) This is a variant oflistTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)operation.default PutDataLakeSettingsResponseputDataLakeSettings(Consumer<PutDataLakeSettingsRequest.Builder> putDataLakeSettingsRequest) Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.default PutDataLakeSettingsResponseputDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest) Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.default RegisterResourceResponseregisterResource(Consumer<RegisterResourceRequest.Builder> registerResourceRequest) Registers the resource as managed by the Data Catalog.default RegisterResourceResponseregisterResource(RegisterResourceRequest registerResourceRequest) Registers the resource as managed by the Data Catalog.default RemoveLfTagsFromResourceResponseremoveLFTagsFromResource(Consumer<RemoveLfTagsFromResourceRequest.Builder> removeLfTagsFromResourceRequest) Removes an LF-tag from the resource.default RemoveLfTagsFromResourceResponseremoveLFTagsFromResource(RemoveLfTagsFromResourceRequest removeLfTagsFromResourceRequest) Removes an LF-tag from the resource.default RevokePermissionsResponserevokePermissions(Consumer<RevokePermissionsRequest.Builder> revokePermissionsRequest) Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.default RevokePermissionsResponserevokePermissions(RevokePermissionsRequest revokePermissionsRequest) Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.default SearchDatabasesByLfTagsResponsesearchDatabasesByLFTags(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) This operation allows a search onDATABASEresources byTagCondition.default SearchDatabasesByLfTagsResponsesearchDatabasesByLFTags(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) This operation allows a search onDATABASEresources byTagCondition.default SearchDatabasesByLFTagsIterablesearchDatabasesByLFTagsPaginator(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) This is a variant ofsearchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)operation.default SearchDatabasesByLFTagsIterablesearchDatabasesByLFTagsPaginator(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) This is a variant ofsearchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)operation.default SearchTablesByLfTagsResponsesearchTablesByLFTags(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) This operation allows a search onTABLEresources byLFTags.default SearchTablesByLfTagsResponsesearchTablesByLFTags(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) This operation allows a search onTABLEresources byLFTags.default SearchTablesByLFTagsIterablesearchTablesByLFTagsPaginator(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) This is a variant ofsearchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)operation.default SearchTablesByLFTagsIterablesearchTablesByLFTagsPaginator(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) This is a variant ofsearchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault StartQueryPlanningResponsestartQueryPlanning(Consumer<StartQueryPlanningRequest.Builder> startQueryPlanningRequest) Submits a request to process a query statement.default StartQueryPlanningResponsestartQueryPlanning(StartQueryPlanningRequest startQueryPlanningRequest) Submits a request to process a query statement.default StartTransactionResponsestartTransaction(Consumer<StartTransactionRequest.Builder> startTransactionRequest) Starts a new transaction and returns its transaction ID.default StartTransactionResponsestartTransaction(StartTransactionRequest startTransactionRequest) Starts a new transaction and returns its transaction ID.default UpdateDataCellsFilterResponseupdateDataCellsFilter(Consumer<UpdateDataCellsFilterRequest.Builder> updateDataCellsFilterRequest) Updates a data cell filter.default UpdateDataCellsFilterResponseupdateDataCellsFilter(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 UpdateLfTagResponseupdateLFTag(Consumer<UpdateLfTagRequest.Builder> updateLfTagRequest) Updates the list of possible values for the specified LF-tag key.default UpdateLfTagResponseupdateLFTag(UpdateLfTagRequest updateLfTagRequest) Updates the list of possible values for the specified LF-tag key.default UpdateResourceResponseupdateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) Updates the data access role used for vending access to the given (registered) resource in Lake Formation.default UpdateResourceResponseupdateResource(UpdateResourceRequest updateResourceRequest) Updates the data access role used for vending access to the given (registered) resource in Lake Formation.default UpdateTableObjectsResponseupdateTableObjects(Consumer<UpdateTableObjectsRequest.Builder> updateTableObjectsRequest) Updates the manifest of Amazon S3 objects that make up the specified governed table.default UpdateTableObjectsResponseupdateTableObjects(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 AddLfTagsToResourceResponse addLFTagsToResource(AddLfTagsToResourceRequest addLfTagsToResourceRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Attaches one or more LF-tags to an existing resource.
- Parameters:
addLfTagsToResourceRequest-- Returns:
- Result of the AddLFTagsToResource operation returned by the service.
- See Also:
-
addLFTagsToResource
default AddLfTagsToResourceResponse addLFTagsToResource(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Attaches one or more LF-tags to an existing resource.
This is a convenience which creates an instance of the
AddLfTagsToResourceRequest.Builderavoiding the need to create one manually viaAddLfTagsToResourceRequest.builder()- Parameters:
addLfTagsToResourceRequest- AConsumerthat will call methods onAddLfTagsToResourceRequest.Builderto create a request.- Returns:
- Result of the AddLFTagsToResource operation returned by the service.
- See Also:
-
assumeDecoratedRoleWithSAML
default AssumeDecoratedRoleWithSamlResponse assumeDecoratedRoleWithSAML(AssumeDecoratedRoleWithSamlRequest assumeDecoratedRoleWithSamlRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.
This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API
GetDataAccess. Therefore, all SAML roles that can be assumed 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:
- Result of the AssumeDecoratedRoleWithSAML operation returned by the service.
- See Also:
-
assumeDecoratedRoleWithSAML
default AssumeDecoratedRoleWithSamlResponse assumeDecoratedRoleWithSAML(Consumer<AssumeDecoratedRoleWithSamlRequest.Builder> assumeDecoratedRoleWithSamlRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.
This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API
GetDataAccess. Therefore, all SAML roles that can be assumed 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:
- Result of the AssumeDecoratedRoleWithSAML operation returned by the service.
- See Also:
-
batchGrantPermissions
default BatchGrantPermissionsResponse batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Batch operation to grant permissions to the principal.
- Parameters:
batchGrantPermissionsRequest-- Returns:
- Result of the BatchGrantPermissions operation returned by the service.
- See Also:
-
batchGrantPermissions
default BatchGrantPermissionsResponse batchGrantPermissions(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Batch operation to grant permissions to the principal.
This is a convenience which creates an instance of the
BatchGrantPermissionsRequest.Builderavoiding the need to create one manually viaBatchGrantPermissionsRequest.builder()- Parameters:
batchGrantPermissionsRequest- AConsumerthat will call methods onBatchGrantPermissionsRequest.Builderto create a request.- Returns:
- Result of the BatchGrantPermissions operation returned by the service.
- See Also:
-
batchRevokePermissions
default BatchRevokePermissionsResponse batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Batch operation to revoke permissions from the principal.
- Parameters:
batchRevokePermissionsRequest-- Returns:
- Result of the BatchRevokePermissions operation returned by the service.
- See Also:
-
batchRevokePermissions
default BatchRevokePermissionsResponse batchRevokePermissions(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Batch operation to revoke permissions from the principal.
This is a convenience which creates an instance of the
BatchRevokePermissionsRequest.Builderavoiding the need to create one manually viaBatchRevokePermissionsRequest.builder()- Parameters:
batchRevokePermissionsRequest- AConsumerthat will call methods onBatchRevokePermissionsRequest.Builderto create a request.- Returns:
- Result of the BatchRevokePermissions operation returned by the service.
- See Also:
-
cancelTransaction
default CancelTransactionResponse cancelTransaction(CancelTransactionRequest cancelTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCommittedException, TransactionCommitInProgressException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
- Parameters:
cancelTransactionRequest-- Returns:
- Result of the CancelTransaction operation returned by the service.
- See Also:
-
cancelTransaction
default CancelTransactionResponse cancelTransaction(Consumer<CancelTransactionRequest.Builder> cancelTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCommittedException, TransactionCommitInProgressException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
This is a convenience which creates an instance of the
CancelTransactionRequest.Builderavoiding the need to create one manually viaCancelTransactionRequest.builder()- Parameters:
cancelTransactionRequest- AConsumerthat will call methods onCancelTransactionRequest.Builderto create a request.- Returns:
- Result of the CancelTransaction operation returned by the service.
- See Also:
-
commitTransaction
default CommitTransactionResponse commitTransaction(CommitTransactionRequest commitTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCanceledException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.
- Parameters:
commitTransactionRequest-- Returns:
- Result of the CommitTransaction operation returned by the service.
- See Also:
-
commitTransaction
default CommitTransactionResponse commitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCanceledException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.
This is a convenience which creates an instance of the
CommitTransactionRequest.Builderavoiding the need to create one manually viaCommitTransactionRequest.builder()- Parameters:
commitTransactionRequest- AConsumerthat will call methods onCommitTransactionRequest.Builderto create a request.- Returns:
- Result of the CommitTransaction operation returned by the service.
- See Also:
-
createDataCellsFilter
default CreateDataCellsFilterResponse createDataCellsFilter(CreateDataCellsFilterRequest createDataCellsFilterRequest) throws AlreadyExistsException, InvalidInputException, EntityNotFoundException, ResourceNumberLimitExceededException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Creates a data cell filter to allow one to grant access to certain columns on certain rows.
- Parameters:
createDataCellsFilterRequest-- Returns:
- Result of the CreateDataCellsFilter operation returned by the service.
- See Also:
-
createDataCellsFilter
default CreateDataCellsFilterResponse createDataCellsFilter(Consumer<CreateDataCellsFilterRequest.Builder> createDataCellsFilterRequest) throws AlreadyExistsException, InvalidInputException, EntityNotFoundException, ResourceNumberLimitExceededException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Creates a data cell filter to allow one to grant access to certain columns on certain rows.
This is a convenience which creates an instance of the
CreateDataCellsFilterRequest.Builderavoiding the need to create one manually viaCreateDataCellsFilterRequest.builder()- Parameters:
createDataCellsFilterRequest- AConsumerthat will call methods onCreateDataCellsFilterRequest.Builderto create a request.- Returns:
- Result of the CreateDataCellsFilter operation returned by the service.
- See Also:
-
createLFTag
default CreateLfTagResponse createLFTag(CreateLfTagRequest createLfTagRequest) throws EntityNotFoundException, InvalidInputException, ResourceNumberLimitExceededException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Creates an LF-tag with the specified name and values.
- Parameters:
createLfTagRequest-- Returns:
- Result of the CreateLFTag operation returned by the service.
- See Also:
-
createLFTag
default CreateLfTagResponse createLFTag(Consumer<CreateLfTagRequest.Builder> createLfTagRequest) throws EntityNotFoundException, InvalidInputException, ResourceNumberLimitExceededException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Creates an LF-tag with the specified name and values.
This is a convenience which creates an instance of the
CreateLfTagRequest.Builderavoiding the need to create one manually viaCreateLfTagRequest.builder()- Parameters:
createLfTagRequest- AConsumerthat will call methods onCreateLfTagRequest.Builderto create a request.- Returns:
- Result of the CreateLFTag operation returned by the service.
- See Also:
-
createLakeFormationIdentityCenterConfiguration
default CreateLakeFormationIdentityCenterConfigurationResponse createLakeFormationIdentityCenterConfiguration(CreateLakeFormationIdentityCenterConfigurationRequest createLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, AlreadyExistsException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
- Parameters:
createLakeFormationIdentityCenterConfigurationRequest-- Returns:
- Result of the CreateLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
createLakeFormationIdentityCenterConfiguration
default CreateLakeFormationIdentityCenterConfigurationResponse createLakeFormationIdentityCenterConfiguration(Consumer<CreateLakeFormationIdentityCenterConfigurationRequest.Builder> createLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, AlreadyExistsException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
This is a convenience which creates an instance of the
CreateLakeFormationIdentityCenterConfigurationRequest.Builderavoiding the need to create one manually viaCreateLakeFormationIdentityCenterConfigurationRequest.builder()- Parameters:
createLakeFormationIdentityCenterConfigurationRequest- AConsumerthat will call methods onCreateLakeFormationIdentityCenterConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreateLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
createLakeFormationOptIn
default CreateLakeFormationOptInResponse createLakeFormationOptIn(CreateLakeFormationOptInRequest createLakeFormationOptInRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Enforce Lake Formation permissions for the given databases, tables, and principals.
- Parameters:
createLakeFormationOptInRequest-- Returns:
- Result of the CreateLakeFormationOptIn operation returned by the service.
- See Also:
-
createLakeFormationOptIn
default CreateLakeFormationOptInResponse createLakeFormationOptIn(Consumer<CreateLakeFormationOptInRequest.Builder> createLakeFormationOptInRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Enforce Lake Formation permissions for the given databases, tables, and principals.
This is a convenience which creates an instance of the
CreateLakeFormationOptInRequest.Builderavoiding the need to create one manually viaCreateLakeFormationOptInRequest.builder()- Parameters:
createLakeFormationOptInRequest- AConsumerthat will call methods onCreateLakeFormationOptInRequest.Builderto create a request.- Returns:
- Result of the CreateLakeFormationOptIn operation returned by the service.
- See Also:
-
deleteDataCellsFilter
default DeleteDataCellsFilterResponse deleteDataCellsFilter(DeleteDataCellsFilterRequest deleteDataCellsFilterRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Deletes a data cell filter.
- Parameters:
deleteDataCellsFilterRequest-- Returns:
- Result of the DeleteDataCellsFilter operation returned by the service.
- See Also:
-
deleteDataCellsFilter
default DeleteDataCellsFilterResponse deleteDataCellsFilter(Consumer<DeleteDataCellsFilterRequest.Builder> deleteDataCellsFilterRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Deletes a data cell filter.
This is a convenience which creates an instance of the
DeleteDataCellsFilterRequest.Builderavoiding the need to create one manually viaDeleteDataCellsFilterRequest.builder()- Parameters:
deleteDataCellsFilterRequest- AConsumerthat will call methods onDeleteDataCellsFilterRequest.Builderto create a request.- Returns:
- Result of the DeleteDataCellsFilter operation returned by the service.
- See Also:
-
deleteLFTag
default DeleteLfTagResponse deleteLFTag(DeleteLfTagRequest deleteLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the
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:
- Result of the DeleteLFTag operation returned by the service.
- See Also:
-
deleteLFTag
default DeleteLfTagResponse deleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the
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:
- Result of the DeleteLFTag operation returned by the service.
- See Also:
-
deleteLakeFormationIdentityCenterConfiguration
default DeleteLakeFormationIdentityCenterConfigurationResponse deleteLakeFormationIdentityCenterConfiguration(DeleteLakeFormationIdentityCenterConfigurationRequest deleteLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Deletes an IAM Identity Center connection with Lake Formation.
- Parameters:
deleteLakeFormationIdentityCenterConfigurationRequest-- Returns:
- Result of the DeleteLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
deleteLakeFormationIdentityCenterConfiguration
default DeleteLakeFormationIdentityCenterConfigurationResponse deleteLakeFormationIdentityCenterConfiguration(Consumer<DeleteLakeFormationIdentityCenterConfigurationRequest.Builder> deleteLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Deletes an IAM Identity Center connection with Lake Formation.
This is a convenience which creates an instance of the
DeleteLakeFormationIdentityCenterConfigurationRequest.Builderavoiding the need to create one manually viaDeleteLakeFormationIdentityCenterConfigurationRequest.builder()- Parameters:
deleteLakeFormationIdentityCenterConfigurationRequest- AConsumerthat will call methods onDeleteLakeFormationIdentityCenterConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
deleteLakeFormationOptIn
default DeleteLakeFormationOptInResponse deleteLakeFormationOptIn(DeleteLakeFormationOptInRequest deleteLakeFormationOptInRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
- Parameters:
deleteLakeFormationOptInRequest-- Returns:
- Result of the DeleteLakeFormationOptIn operation returned by the service.
- See Also:
-
deleteLakeFormationOptIn
default DeleteLakeFormationOptInResponse deleteLakeFormationOptIn(Consumer<DeleteLakeFormationOptInRequest.Builder> deleteLakeFormationOptInRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
This is a convenience which creates an instance of the
DeleteLakeFormationOptInRequest.Builderavoiding the need to create one manually viaDeleteLakeFormationOptInRequest.builder()- Parameters:
deleteLakeFormationOptInRequest- AConsumerthat will call methods onDeleteLakeFormationOptInRequest.Builderto create a request.- Returns:
- Result of the DeleteLakeFormationOptIn operation returned by the service.
- See Also:
-
deleteObjectsOnCancel
default DeleteObjectsOnCancelResponse deleteObjectsOnCancel(DeleteObjectsOnCancelRequest deleteObjectsOnCancelRequest) throws InternalServiceException, InvalidInputException, OperationTimeoutException, EntityNotFoundException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.
The Glue ETL library function
write_dynamic_frame.from_catalog()includes an option to automatically callDeleteObjectsOnCancelbefore writes. For more information, see Rolling Back Amazon S3 Writes.- Parameters:
deleteObjectsOnCancelRequest-- Returns:
- Result of the DeleteObjectsOnCancel operation returned by the service.
- See Also:
-
deleteObjectsOnCancel
default DeleteObjectsOnCancelResponse deleteObjectsOnCancel(Consumer<DeleteObjectsOnCancelRequest.Builder> deleteObjectsOnCancelRequest) throws InternalServiceException, InvalidInputException, OperationTimeoutException, EntityNotFoundException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.
The Glue ETL library function
write_dynamic_frame.from_catalog()includes an option to automatically 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:
- Result of the DeleteObjectsOnCancel operation returned by the service.
- See Also:
-
deregisterResource
default DeregisterResourceResponse deregisterResource(DeregisterResourceRequest deregisterResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException Deregisters the resource as managed by the Data Catalog.
When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
- Parameters:
deregisterResourceRequest-- Returns:
- Result of the DeregisterResource operation returned by the service.
- See Also:
-
deregisterResource
default DeregisterResourceResponse deregisterResource(Consumer<DeregisterResourceRequest.Builder> deregisterResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException Deregisters the resource as managed by the Data Catalog.
When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
This is a convenience which creates an instance of the
DeregisterResourceRequest.Builderavoiding the need to create one manually viaDeregisterResourceRequest.builder()- Parameters:
deregisterResourceRequest- AConsumerthat will call methods onDeregisterResourceRequest.Builderto create a request.- Returns:
- Result of the DeregisterResource operation returned by the service.
- See Also:
-
describeLakeFormationIdentityCenterConfiguration
default DescribeLakeFormationIdentityCenterConfigurationResponse describeLakeFormationIdentityCenterConfiguration(DescribeLakeFormationIdentityCenterConfigurationRequest describeLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the instance ARN and application ARN for the connection.
- Parameters:
describeLakeFormationIdentityCenterConfigurationRequest-- Returns:
- Result of the DescribeLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
describeLakeFormationIdentityCenterConfiguration
default DescribeLakeFormationIdentityCenterConfigurationResponse describeLakeFormationIdentityCenterConfiguration(Consumer<DescribeLakeFormationIdentityCenterConfigurationRequest.Builder> describeLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the instance ARN and application ARN for the connection.
This is a convenience which creates an instance of the
DescribeLakeFormationIdentityCenterConfigurationRequest.Builderavoiding the need to create one manually viaDescribeLakeFormationIdentityCenterConfigurationRequest.builder()- Parameters:
describeLakeFormationIdentityCenterConfigurationRequest- AConsumerthat will call methods onDescribeLakeFormationIdentityCenterConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
describeResource
default DescribeResourceResponse describeResource(DescribeResourceRequest describeResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the current data access role for the given resource registered in Lake Formation.
- Parameters:
describeResourceRequest-- Returns:
- Result of the DescribeResource operation returned by the service.
- See Also:
-
describeResource
default DescribeResourceResponse describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the current data access role for the given resource registered in Lake Formation.
This is a convenience which creates an instance of the
DescribeResourceRequest.Builderavoiding the need to create one manually viaDescribeResourceRequest.builder()- Parameters:
describeResourceRequest- AConsumerthat will call methods onDescribeResourceRequest.Builderto create a request.- Returns:
- Result of the DescribeResource operation returned by the service.
- See Also:
-
describeTransaction
default DescribeTransactionResponse describeTransaction(DescribeTransactionRequest describeTransactionRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Returns the details of a single transaction.
- Parameters:
describeTransactionRequest-- Returns:
- Result of the DescribeTransaction operation returned by the service.
- See Also:
-
describeTransaction
default DescribeTransactionResponse describeTransaction(Consumer<DescribeTransactionRequest.Builder> describeTransactionRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Returns the details of a single transaction.
This is a convenience which creates an instance of the
DescribeTransactionRequest.Builderavoiding the need to create one manually viaDescribeTransactionRequest.builder()- Parameters:
describeTransactionRequest- AConsumerthat will call methods onDescribeTransactionRequest.Builderto create a request.- Returns:
- Result of the DescribeTransaction operation returned by the service.
- See Also:
-
extendTransaction
default ExtendTransactionResponse extendTransaction(ExtendTransactionRequest extendTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, TransactionCommitInProgressException, AwsServiceException, SdkClientException, LakeFormationException Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.
- Parameters:
extendTransactionRequest-- Returns:
- Result of the ExtendTransaction operation returned by the service.
- See Also:
-
extendTransaction
default ExtendTransactionResponse extendTransaction(Consumer<ExtendTransactionRequest.Builder> extendTransactionRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, TransactionCommitInProgressException, AwsServiceException, SdkClientException, LakeFormationException Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.
This is a convenience which creates an instance of the
ExtendTransactionRequest.Builderavoiding the need to create one manually viaExtendTransactionRequest.builder()- Parameters:
extendTransactionRequest- AConsumerthat will call methods onExtendTransactionRequest.Builderto create a request.- Returns:
- Result of the ExtendTransaction operation returned by the service.
- See Also:
-
getDataCellsFilter
default GetDataCellsFilterResponse getDataCellsFilter(GetDataCellsFilterRequest getDataCellsFilterRequest) throws EntityNotFoundException, InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns a data cells filter.
- Parameters:
getDataCellsFilterRequest-- Returns:
- Result of the GetDataCellsFilter operation returned by the service.
- See Also:
-
getDataCellsFilter
default GetDataCellsFilterResponse getDataCellsFilter(Consumer<GetDataCellsFilterRequest.Builder> getDataCellsFilterRequest) throws EntityNotFoundException, InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns a data cells filter.
This is a convenience which creates an instance of the
GetDataCellsFilterRequest.Builderavoiding the need to create one manually viaGetDataCellsFilterRequest.builder()- Parameters:
getDataCellsFilterRequest- AConsumerthat will call methods onGetDataCellsFilterRequest.Builderto create a request.- Returns:
- Result of the GetDataCellsFilter operation returned by the service.
- See Also:
-
getDataLakePrincipal
default GetDataLakePrincipalResponse getDataLakePrincipal(GetDataLakePrincipalRequest getDataLakePrincipalRequest) throws InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns the identity of the invoking principal.
- Parameters:
getDataLakePrincipalRequest-- Returns:
- Result of the GetDataLakePrincipal operation returned by the service.
- See Also:
-
getDataLakePrincipal
default GetDataLakePrincipalResponse getDataLakePrincipal(Consumer<GetDataLakePrincipalRequest.Builder> getDataLakePrincipalRequest) throws InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns the identity of the invoking principal.
This is a convenience which creates an instance of the
GetDataLakePrincipalRequest.Builderavoiding the need to create one manually viaGetDataLakePrincipalRequest.builder()- Parameters:
getDataLakePrincipalRequest- AConsumerthat will call methods onGetDataLakePrincipalRequest.Builderto create a request.- Returns:
- Result of the GetDataLakePrincipal operation returned by the service.
- See Also:
-
getDataLakeSettings
default GetDataLakeSettingsResponse getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
- Parameters:
getDataLakeSettingsRequest-- Returns:
- Result of the GetDataLakeSettings operation returned by the service.
- See Also:
-
getDataLakeSettings
default GetDataLakeSettingsResponse getDataLakeSettings(Consumer<GetDataLakeSettingsRequest.Builder> getDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
This is a convenience which creates an instance of the
GetDataLakeSettingsRequest.Builderavoiding the need to create one manually viaGetDataLakeSettingsRequest.builder()- Parameters:
getDataLakeSettingsRequest- AConsumerthat will call methods onGetDataLakeSettingsRequest.Builderto create a request.- Returns:
- Result of the GetDataLakeSettings operation returned by the service.
- See Also:
-
getEffectivePermissionsForPath
default GetEffectivePermissionsForPathResponse getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
GetEffectivePermissionsForPathwill not return databases and tables if the catalog is encrypted.- Parameters:
getEffectivePermissionsForPathRequest-- Returns:
- Result of the GetEffectivePermissionsForPath operation returned by the service.
- See Also:
-
getEffectivePermissionsForPath
default GetEffectivePermissionsForPathResponse getEffectivePermissionsForPath(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
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:
- Result of the GetEffectivePermissionsForPath operation returned by the service.
- See Also:
-
getEffectivePermissionsForPathPaginator
default GetEffectivePermissionsForPathIterable getEffectivePermissionsForPathPaginator(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client .getEffectivePermissionsForPathPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)operation.- Parameters:
getEffectivePermissionsForPathRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getEffectivePermissionsForPathPaginator
default GetEffectivePermissionsForPathIterable getEffectivePermissionsForPathPaginator(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client .getEffectivePermissionsForPathPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)operation.
This is a convenience which creates an instance of the
GetEffectivePermissionsForPathRequest.Builderavoiding the need to create one manually viaGetEffectivePermissionsForPathRequest.builder()- Parameters:
getEffectivePermissionsForPathRequest- AConsumerthat will call methods onGetEffectivePermissionsForPathRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getLFTag
default GetLfTagResponse getLFTag(GetLfTagRequest getLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns an LF-tag definition.
- Parameters:
getLfTagRequest-- Returns:
- Result of the GetLFTag operation returned by the service.
- See Also:
-
getLFTag
default GetLfTagResponse getLFTag(Consumer<GetLfTagRequest.Builder> getLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns an LF-tag definition.
This is a convenience which creates an instance of the
GetLfTagRequest.Builderavoiding the need to create one manually viaGetLfTagRequest.builder()- Parameters:
getLfTagRequest- AConsumerthat will call methods onGetLfTagRequest.Builderto create a request.- Returns:
- Result of the GetLFTag operation returned by the service.
- See Also:
-
getQueryState
default GetQueryStateResponse getQueryState(GetQueryStateRequest getQueryStateRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns the state of a query previously submitted. Clients are expected to poll
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:
- Result of the GetQueryState operation returned by the service.
- See Also:
-
getQueryState
default GetQueryStateResponse getQueryState(Consumer<GetQueryStateRequest.Builder> getQueryStateRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns the state of a query previously submitted. Clients are expected to poll
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:
- Result of the GetQueryState operation returned by the service.
- See Also:
-
getQueryStatistics
default GetQueryStatisticsResponse getQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest) throws StatisticsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Retrieves statistics on the planning and execution of a query.
- Parameters:
getQueryStatisticsRequest-- Returns:
- Result of the GetQueryStatistics operation returned by the service.
- See Also:
-
getQueryStatistics
default GetQueryStatisticsResponse getQueryStatistics(Consumer<GetQueryStatisticsRequest.Builder> getQueryStatisticsRequest) throws StatisticsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Retrieves statistics on the planning and execution of a query.
This is a convenience which creates an instance of the
GetQueryStatisticsRequest.Builderavoiding the need to create one manually viaGetQueryStatisticsRequest.builder()- Parameters:
getQueryStatisticsRequest- AConsumerthat will call methods onGetQueryStatisticsRequest.Builderto create a request.- Returns:
- Result of the GetQueryStatistics operation returned by the service.
- See Also:
-
getResourceLFTags
default GetResourceLfTagsResponse getResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns the LF-tags applied to a resource.
- Parameters:
getResourceLfTagsRequest-- Returns:
- Result of the GetResourceLFTags operation returned by the service.
- See Also:
-
getResourceLFTags
default GetResourceLfTagsResponse getResourceLFTags(Consumer<GetResourceLfTagsRequest.Builder> getResourceLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Returns the LF-tags applied to a resource.
This is a convenience which creates an instance of the
GetResourceLfTagsRequest.Builderavoiding the need to create one manually viaGetResourceLfTagsRequest.builder()- Parameters:
getResourceLfTagsRequest- AConsumerthat will call methods onGetResourceLfTagsRequest.Builderto create a request.- Returns:
- Result of the GetResourceLFTags operation returned by the service.
- See Also:
-
getTableObjects
default GetTableObjectsResponse getTableObjects(GetTableObjectsRequest getTableObjectsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, AwsServiceException, SdkClientException, LakeFormationException Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
- Parameters:
getTableObjectsRequest-- Returns:
- Result of the GetTableObjects operation returned by the service.
- See Also:
-
getTableObjects
default GetTableObjectsResponse getTableObjects(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, AwsServiceException, SdkClientException, LakeFormationException Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
This is a convenience which creates an instance of the
GetTableObjectsRequest.Builderavoiding the need to create one manually viaGetTableObjectsRequest.builder()- Parameters:
getTableObjectsRequest- AConsumerthat will call methods onGetTableObjectsRequest.Builderto create a request.- Returns:
- Result of the GetTableObjects operation returned by the service.
- See Also:
-
getTableObjectsPaginator
default GetTableObjectsIterable getTableObjectsPaginator(GetTableObjectsRequest getTableObjectsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client.getTableObjectsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client .getTableObjectsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client.getTableObjectsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)operation.- Parameters:
getTableObjectsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTableObjectsPaginator
default GetTableObjectsIterable getTableObjectsPaginator(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, TransactionCommittedException, TransactionCanceledException, ResourceNotReadyException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client.getTableObjectsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client .getTableObjectsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsIterable responses = client.getTableObjectsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)operation.
This is a convenience which creates an instance of the
GetTableObjectsRequest.Builderavoiding the need to create one manually viaGetTableObjectsRequest.builder()- Parameters:
getTableObjectsRequest- AConsumerthat will call methods onGetTableObjectsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTemporaryGluePartitionCredentials
default GetTemporaryGluePartitionCredentialsResponse getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest getTemporaryGluePartitionCredentialsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, PermissionTypeMismatchException, AwsServiceException, SdkClientException, LakeFormationException This API is identical to
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:
- Result of the GetTemporaryGluePartitionCredentials operation returned by the service.
- See Also:
-
getTemporaryGluePartitionCredentials
default GetTemporaryGluePartitionCredentialsResponse getTemporaryGluePartitionCredentials(Consumer<GetTemporaryGluePartitionCredentialsRequest.Builder> getTemporaryGluePartitionCredentialsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, PermissionTypeMismatchException, AwsServiceException, SdkClientException, LakeFormationException This API is identical to
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:
- Result of the GetTemporaryGluePartitionCredentials operation returned by the service.
- See Also:
-
getTemporaryGlueTableCredentials
default GetTemporaryGlueTableCredentialsResponse getTemporaryGlueTableCredentials(GetTemporaryGlueTableCredentialsRequest getTemporaryGlueTableCredentialsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, PermissionTypeMismatchException, AwsServiceException, SdkClientException, LakeFormationException Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
- Parameters:
getTemporaryGlueTableCredentialsRequest-- Returns:
- Result of the GetTemporaryGlueTableCredentials operation returned by the service.
- See Also:
-
getTemporaryGlueTableCredentials
default GetTemporaryGlueTableCredentialsResponse getTemporaryGlueTableCredentials(Consumer<GetTemporaryGlueTableCredentialsRequest.Builder> getTemporaryGlueTableCredentialsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AccessDeniedException, PermissionTypeMismatchException, AwsServiceException, SdkClientException, LakeFormationException Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
This is a convenience which creates an instance of the
GetTemporaryGlueTableCredentialsRequest.Builderavoiding the need to create one manually viaGetTemporaryGlueTableCredentialsRequest.builder()- Parameters:
getTemporaryGlueTableCredentialsRequest- AConsumerthat will call methods onGetTemporaryGlueTableCredentialsRequest.Builderto create a request.- Returns:
- Result of the GetTemporaryGlueTableCredentials operation returned by the service.
- See Also:
-
getWorkUnitResults
default <ReturnT> ReturnT getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, ResponseTransformer<GetWorkUnitResultsResponse, ReturnT> responseTransformer) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationExceptionReturns the work units resulting from the query. Work units can be executed in any order and in parallel.
- Parameters:
getWorkUnitResultsRequest-responseTransformer- Functional interface for processing the streamed response content. The unmarshalled GetWorkUnitResultsResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. SeeResponseTransformerfor details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'Rows returned from the
'.GetWorkUnitResultsoperation as a stream of Apache Arrow v1.0 messages.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getWorkUnitResults
default <ReturnT> ReturnT getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, ResponseTransformer<GetWorkUnitResultsResponse, ReturnT> responseTransformer) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationExceptionReturns the work units resulting from the query. Work units can be executed in any order and in parallel.
This is a convenience which creates an instance of the
GetWorkUnitResultsRequest.Builderavoiding the need to create one manually viaGetWorkUnitResultsRequest.builder()- Parameters:
getWorkUnitResultsRequest- AConsumerthat will call methods onGetWorkUnitResultsRequest.Builderto create a request.responseTransformer- Functional interface for processing the streamed response content. The unmarshalled GetWorkUnitResultsResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. SeeResponseTransformerfor details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows 'Rows returned from the
'.GetWorkUnitResultsoperation as a stream of Apache Arrow v1.0 messages.- Returns:
- The transformed result of the ResponseTransformer.
- See Also:
-
getWorkUnitResults
default GetWorkUnitResultsResponse getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, Path destinationPath) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
- Parameters:
getWorkUnitResultsRequest-destinationPath-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:
- The transformed result of the ResponseTransformer.
- See Also:
-
getWorkUnitResults
default GetWorkUnitResultsResponse getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, Path destinationPath) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
This is a convenience which creates an instance of the
GetWorkUnitResultsRequest.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:
- The transformed result of the ResponseTransformer.
- See Also:
-
getWorkUnitResults
default ResponseInputStream<GetWorkUnitResultsResponse> getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
- Parameters:
getWorkUnitResultsRequest-- Returns:
- A
ResponseInputStreamcontaining data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained viaResponseInputStream.response(). The service documentation for the response content is as follows 'Rows returned from the
'.GetWorkUnitResultsoperation as a stream of Apache Arrow v1.0 messages. - See Also:
-
getWorkUnitResults
default ResponseInputStream<GetWorkUnitResultsResponse> getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
This is a convenience which creates an instance of the
GetWorkUnitResultsRequest.Builderavoiding the need to create one manually viaGetWorkUnitResultsRequest.builder()- Parameters:
getWorkUnitResultsRequest- AConsumerthat will call methods onGetWorkUnitResultsRequest.Builderto create a request.- Returns:
- A
ResponseInputStreamcontaining data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained viaResponseInputStream.response(). The service documentation for the response content is as follows 'Rows returned from the
'.GetWorkUnitResultsoperation as a stream of Apache Arrow v1.0 messages. - See Also:
-
getWorkUnitResultsAsBytes
default ResponseBytes<GetWorkUnitResultsResponse> getWorkUnitResultsAsBytes(GetWorkUnitResultsRequest getWorkUnitResultsRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
- Parameters:
getWorkUnitResultsRequest-- Returns:
- A
ResponseBytesthat loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained viaResponseBytes.response(). The service documentation for the response content is as follows 'Rows returned from the
'.GetWorkUnitResultsoperation as a stream of Apache Arrow v1.0 messages. - See Also:
-
getWorkUnitResultsAsBytes
default ResponseBytes<GetWorkUnitResultsResponse> getWorkUnitResultsAsBytes(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
This is a convenience which creates an instance of the
GetWorkUnitResultsRequest.Builderavoiding the need to create one manually viaGetWorkUnitResultsRequest.builder()- Parameters:
getWorkUnitResultsRequest- AConsumerthat will call methods onGetWorkUnitResultsRequest.Builderto create a request.- Returns:
- A
ResponseBytesthat loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained viaResponseBytes.response(). The service documentation for the response content is as follows 'Rows returned from the
'.GetWorkUnitResultsoperation as a stream of Apache Arrow v1.0 messages. - See Also:
-
getWorkUnits
default GetWorkUnitsResponse getWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the work units generated by the
StartQueryPlanningoperation.- Parameters:
getWorkUnitsRequest-- Returns:
- Result of the GetWorkUnits operation returned by the service.
- See Also:
-
getWorkUnits
default GetWorkUnitsResponse getWorkUnits(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException Retrieves the work units generated by the
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:
- Result of the GetWorkUnits operation returned by the service.
- See Also:
-
getWorkUnitsPaginator
default GetWorkUnitsIterable getWorkUnitsPaginator(GetWorkUnitsRequest getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client.getWorkUnitsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client .getWorkUnitsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client.getWorkUnitsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)operation.- Parameters:
getWorkUnitsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getWorkUnitsPaginator
default GetWorkUnitsIterable getWorkUnitsPaginator(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest) throws WorkUnitsNotReadyYetException, InternalServiceException, InvalidInputException, AccessDeniedException, ExpiredException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client.getWorkUnitsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client .getWorkUnitsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsIterable responses = client.getWorkUnitsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest)operation.
This is a convenience which creates an instance of the
GetWorkUnitsRequest.Builderavoiding the need to create one manually viaGetWorkUnitsRequest.builder()- Parameters:
getWorkUnitsRequest- AConsumerthat will call methods onGetWorkUnitsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
grantPermissions
default GrantPermissionsResponse grantPermissions(GrantPermissionsRequest grantPermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
For information about permissions, see Security and Access Control to Metadata and Data.
- Parameters:
grantPermissionsRequest-- Returns:
- Result of the GrantPermissions operation returned by the service.
- See Also:
-
grantPermissions
default GrantPermissionsResponse grantPermissions(Consumer<GrantPermissionsRequest.Builder> grantPermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a convenience which creates an instance of the
GrantPermissionsRequest.Builderavoiding the need to create one manually viaGrantPermissionsRequest.builder()- Parameters:
grantPermissionsRequest- AConsumerthat will call methods onGrantPermissionsRequest.Builderto create a request.- Returns:
- Result of the GrantPermissions operation returned by the service.
- See Also:
-
listDataCellsFilter
default ListDataCellsFilterResponse listDataCellsFilter(ListDataCellsFilterRequest listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Lists all the data cell filters on a table.
- Parameters:
listDataCellsFilterRequest-- Returns:
- Result of the ListDataCellsFilter operation returned by the service.
- See Also:
-
listDataCellsFilter
default ListDataCellsFilterResponse listDataCellsFilter(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Lists all the data cell filters on a table.
This is a convenience which creates an instance of the
ListDataCellsFilterRequest.Builderavoiding the need to create one manually viaListDataCellsFilterRequest.builder()- Parameters:
listDataCellsFilterRequest- AConsumerthat will call methods onListDataCellsFilterRequest.Builderto create a request.- Returns:
- Result of the ListDataCellsFilter operation returned by the service.
- See Also:
-
listDataCellsFilterPaginator
default ListDataCellsFilterIterable listDataCellsFilterPaginator(ListDataCellsFilterRequest listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client.listDataCellsFilterPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client .listDataCellsFilterPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client.listDataCellsFilterPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)operation.- Parameters:
listDataCellsFilterRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataCellsFilterPaginator
default ListDataCellsFilterIterable listDataCellsFilterPaginator(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client.listDataCellsFilterPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client .listDataCellsFilterPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterIterable responses = client.listDataCellsFilterPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)operation.
This is a convenience which creates an instance of the
ListDataCellsFilterRequest.Builderavoiding the need to create one manually viaListDataCellsFilterRequest.builder()- Parameters:
listDataCellsFilterRequest- AConsumerthat will call methods onListDataCellsFilterRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLFTags
default ListLfTagsResponse listLFTags(ListLfTagsRequest listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Lists LF-tags that the requester has permission to view.
- Parameters:
listLfTagsRequest-- Returns:
- Result of the ListLFTags operation returned by the service.
- See Also:
-
listLFTags
default ListLfTagsResponse listLFTags(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Lists LF-tags that the requester has permission to view.
This is a convenience which creates an instance of the
ListLfTagsRequest.Builderavoiding the need to create one manually viaListLfTagsRequest.builder()- Parameters:
listLfTagsRequest- AConsumerthat will call methods onListLfTagsRequest.Builderto create a request.- Returns:
- Result of the ListLFTags operation returned by the service.
- See Also:
-
listLFTagsPaginator
default ListLFTagsIterable listLFTagsPaginator(ListLfTagsRequest listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)operation.- Parameters:
listLfTagsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLFTagsPaginator
default ListLFTagsIterable listLFTagsPaginator(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListLFTagsIterable responses = client.listLFTagsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)operation.
This is a convenience which creates an instance of the
ListLfTagsRequest.Builderavoiding the need to create one manually viaListLfTagsRequest.builder()- Parameters:
listLfTagsRequest- AConsumerthat will call methods onListLfTagsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLakeFormationOptIns
default ListLakeFormationOptInsResponse listLakeFormationOptIns(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
- Parameters:
listLakeFormationOptInsRequest-- Returns:
- Result of the ListLakeFormationOptIns operation returned by the service.
- See Also:
-
listLakeFormationOptIns
default ListLakeFormationOptInsResponse listLakeFormationOptIns(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
This is a convenience which creates an instance of the
ListLakeFormationOptInsRequest.Builderavoiding the need to create one manually viaListLakeFormationOptInsRequest.builder()- Parameters:
listLakeFormationOptInsRequest- AConsumerthat will call methods onListLakeFormationOptInsRequest.Builderto create a request.- Returns:
- Result of the ListLakeFormationOptIns operation returned by the service.
- See Also:
-
listLakeFormationOptInsPaginator
default ListLakeFormationOptInsIterable listLakeFormationOptInsPaginator(ListLakeFormationOptInsRequest listLakeFormationOptInsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client.listLakeFormationOptInsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client .listLakeFormationOptInsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client.listLakeFormationOptInsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)operation.- Parameters:
listLakeFormationOptInsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listLakeFormationOptInsPaginator
default ListLakeFormationOptInsIterable listLakeFormationOptInsPaginator(Consumer<ListLakeFormationOptInsRequest.Builder> listLakeFormationOptInsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client.listLakeFormationOptInsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client .listLakeFormationOptInsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListLakeFormationOptInsIterable responses = client.listLakeFormationOptInsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLakeFormationOptIns(software.amazon.awssdk.services.lakeformation.model.ListLakeFormationOptInsRequest)operation.
This is a convenience which creates an instance of the
ListLakeFormationOptInsRequest.Builderavoiding the need to create one manually viaListLakeFormationOptInsRequest.builder()- Parameters:
listLakeFormationOptInsRequest- AConsumerthat will call methods onListLakeFormationOptInsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissions
default ListPermissionsResponse listPermissions(ListPermissionsRequest listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
- Parameters:
listPermissionsRequest-- Returns:
- Result of the ListPermissions operation returned by the service.
- See Also:
-
listPermissions
default ListPermissionsResponse listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builderavoiding the need to create one manually viaListPermissionsRequest.builder()- Parameters:
listPermissionsRequest- AConsumerthat will call methods onListPermissionsRequest.Builderto create a request.- Returns:
- Result of the ListPermissions operation returned by the service.
- See Also:
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client .listPermissionsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)operation.- Parameters:
listPermissionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client .listPermissionsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)operation.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builderavoiding the need to create one manually viaListPermissionsRequest.builder()- Parameters:
listPermissionsRequest- AConsumerthat will call methods onListPermissionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResources
default ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Lists the resources registered to be managed by the Data Catalog.
- Parameters:
listResourcesRequest-- Returns:
- Result of the ListResources operation returned by the service.
- See Also:
-
listResources
default ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Lists the resources registered to be managed by the Data Catalog.
This is a convenience which creates an instance of the
ListResourcesRequest.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- Result of the ListResources operation returned by the service.
- See Also:
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client .listResourcesPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)operation.- Parameters:
listResourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client .listResourcesPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest)operation.
This is a convenience which creates an instance of the
ListResourcesRequest.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTableStorageOptimizers
default ListTableStorageOptimizersResponse listTableStorageOptimizers(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException Returns the configuration of all storage optimizers associated with a specified table.
- Parameters:
listTableStorageOptimizersRequest-- Returns:
- Result of the ListTableStorageOptimizers operation returned by the service.
- See Also:
-
listTableStorageOptimizers
default ListTableStorageOptimizersResponse listTableStorageOptimizers(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException Returns the configuration of all storage optimizers associated with a specified table.
This is a convenience which creates an instance of the
ListTableStorageOptimizersRequest.Builderavoiding the need to create one manually viaListTableStorageOptimizersRequest.builder()- Parameters:
listTableStorageOptimizersRequest- AConsumerthat will call methods onListTableStorageOptimizersRequest.Builderto create a request.- Returns:
- Result of the ListTableStorageOptimizers operation returned by the service.
- See Also:
-
listTableStorageOptimizersPaginator
default ListTableStorageOptimizersIterable listTableStorageOptimizersPaginator(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client.listTableStorageOptimizersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client .listTableStorageOptimizersPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client.listTableStorageOptimizersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)operation.- Parameters:
listTableStorageOptimizersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTableStorageOptimizersPaginator
default ListTableStorageOptimizersIterable listTableStorageOptimizersPaginator(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client.listTableStorageOptimizersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client .listTableStorageOptimizersPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersIterable responses = client.listTableStorageOptimizersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)operation.
This is a convenience which creates an instance of the
ListTableStorageOptimizersRequest.Builderavoiding the need to create one manually viaListTableStorageOptimizersRequest.builder()- Parameters:
listTableStorageOptimizersRequest- AConsumerthat will call methods onListTableStorageOptimizersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTransactions
default ListTransactionsResponse listTransactions(ListTransactionsRequest listTransactionsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
This operation can help you identify uncommitted transactions or to get information about transactions.
- Parameters:
listTransactionsRequest-- Returns:
- Result of the ListTransactions operation returned by the service.
- See Also:
-
listTransactions
default ListTransactionsResponse listTransactions(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
This operation can help you identify uncommitted transactions or to get information about transactions.
This is a convenience which creates an instance of the
ListTransactionsRequest.Builderavoiding the need to create one manually viaListTransactionsRequest.builder()- Parameters:
listTransactionsRequest- AConsumerthat will call methods onListTransactionsRequest.Builderto create a request.- Returns:
- Result of the ListTransactions operation returned by the service.
- See Also:
-
listTransactionsPaginator
default ListTransactionsIterable listTransactionsPaginator(ListTransactionsRequest listTransactionsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client.listTransactionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client .listTransactionsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client.listTransactionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)operation.- Parameters:
listTransactionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTransactionsPaginator
default ListTransactionsIterable listTransactionsPaginator(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client.listTransactionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client .listTransactionsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.ListTransactionsIterable responses = client.listTransactionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)operation.
This is a convenience which creates an instance of the
ListTransactionsRequest.Builderavoiding the need to create one manually viaListTransactionsRequest.builder()- Parameters:
listTransactionsRequest- AConsumerthat will call methods onListTransactionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putDataLakeSettings
default PutDataLakeSettingsResponse putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
- Parameters:
putDataLakeSettingsRequest-- Returns:
- Result of the PutDataLakeSettings operation returned by the service.
- See Also:
-
putDataLakeSettings
default PutDataLakeSettingsResponse putDataLakeSettings(Consumer<PutDataLakeSettingsRequest.Builder> putDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
This is a convenience which creates an instance of the
PutDataLakeSettingsRequest.Builderavoiding the need to create one manually viaPutDataLakeSettingsRequest.builder()- Parameters:
putDataLakeSettingsRequest- AConsumerthat will call methods onPutDataLakeSettingsRequest.Builderto create a request.- Returns:
- Result of the PutDataLakeSettings operation returned by the service.
- See Also:
-
registerResource
default RegisterResourceResponse registerResource(RegisterResourceRequest registerResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AlreadyExistsException, EntityNotFoundException, ResourceNumberLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Registers the resource as managed by the Data Catalog.
To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = trueIf
UseServiceLinkedRoleis not set to true, you must provide or set theRoleArn:arn:aws:iam::12345:role/my-data-access-role- Parameters:
registerResourceRequest-- Returns:
- Result of the RegisterResource operation returned by the service.
- See Also:
-
registerResource
default RegisterResourceResponse registerResource(Consumer<RegisterResourceRequest.Builder> registerResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AlreadyExistsException, EntityNotFoundException, ResourceNumberLimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Registers the resource as managed by the Data Catalog.
To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = 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:
- Result of the RegisterResource operation returned by the service.
- See Also:
-
removeLFTagsFromResource
default RemoveLfTagsFromResourceResponse removeLFTagsFromResource(RemoveLfTagsFromResourceRequest removeLfTagsFromResourceRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in
tableWithColumnsto specify column input.- Parameters:
removeLfTagsFromResourceRequest-- Returns:
- Result of the RemoveLFTagsFromResource operation returned by the service.
- See Also:
-
removeLFTagsFromResource
default RemoveLfTagsFromResourceResponse removeLFTagsFromResource(Consumer<RemoveLfTagsFromResourceRequest.Builder> removeLfTagsFromResourceRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in
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:
- Result of the RemoveLFTagsFromResource operation returned by the service.
- See Also:
-
revokePermissions
default RevokePermissionsResponse revokePermissions(RevokePermissionsRequest revokePermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
- Parameters:
revokePermissionsRequest-- Returns:
- Result of the RevokePermissions operation returned by the service.
- See Also:
-
revokePermissions
default RevokePermissionsResponse revokePermissions(Consumer<RevokePermissionsRequest.Builder> revokePermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
This is a convenience which creates an instance of the
RevokePermissionsRequest.Builderavoiding the need to create one manually viaRevokePermissionsRequest.builder()- Parameters:
revokePermissionsRequest- AConsumerthat will call methods onRevokePermissionsRequest.Builderto create a request.- Returns:
- Result of the RevokePermissions operation returned by the service.
- See Also:
-
searchDatabasesByLFTags
default SearchDatabasesByLfTagsResponse searchDatabasesByLFTags(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This operation allows a search on
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:
- Result of the SearchDatabasesByLFTags operation returned by the service.
- See Also:
-
searchDatabasesByLFTags
default SearchDatabasesByLfTagsResponse searchDatabasesByLFTags(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This operation allows a search on
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:
- Result of the SearchDatabasesByLFTags operation returned by the service.
- See Also:
-
searchDatabasesByLFTagsPaginator
default SearchDatabasesByLFTagsIterable searchDatabasesByLFTagsPaginator(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client.searchDatabasesByLFTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client .searchDatabasesByLFTagsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client.searchDatabasesByLFTagsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)operation.- Parameters:
searchDatabasesByLfTagsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchDatabasesByLFTagsPaginator
default SearchDatabasesByLFTagsIterable searchDatabasesByLFTagsPaginator(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client.searchDatabasesByLFTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client .searchDatabasesByLFTagsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsIterable responses = client.searchDatabasesByLFTagsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)operation.
This is a convenience which creates an instance of the
SearchDatabasesByLfTagsRequest.Builderavoiding the need to create one manually viaSearchDatabasesByLfTagsRequest.builder()- Parameters:
searchDatabasesByLfTagsRequest- AConsumerthat will call methods onSearchDatabasesByLfTagsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchTablesByLFTags
default SearchTablesByLfTagsResponse searchTablesByLFTags(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This operation allows a search on
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:
- Result of the SearchTablesByLFTags operation returned by the service.
- See Also:
-
searchTablesByLFTags
default SearchTablesByLfTagsResponse searchTablesByLFTags(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This operation allows a search on
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:
- Result of the SearchTablesByLFTags operation returned by the service.
- See Also:
-
searchTablesByLFTagsPaginator
default SearchTablesByLFTagsIterable searchTablesByLFTagsPaginator(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client.searchTablesByLFTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client .searchTablesByLFTagsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client.searchTablesByLFTagsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)operation.- Parameters:
searchTablesByLfTagsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchTablesByLFTagsPaginator
default SearchTablesByLFTagsIterable searchTablesByLFTagsPaginator(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest) throws EntityNotFoundException, InternalServiceException, InvalidInputException, OperationTimeoutException, GlueEncryptionException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException This is a variant of
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client.searchTablesByLFTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client .searchTablesByLFTagsPaginator(request); for (software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsIterable responses = client.searchTablesByLFTagsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)operation.
This is a convenience which creates an instance of the
SearchTablesByLfTagsRequest.Builderavoiding the need to create one manually viaSearchTablesByLfTagsRequest.builder()- Parameters:
searchTablesByLfTagsRequest- AConsumerthat will call methods onSearchTablesByLfTagsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
startQueryPlanning
default StartQueryPlanningResponse startQueryPlanning(StartQueryPlanningRequest startQueryPlanningRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Submits a request to process a query statement.
This operation generates work units that can be retrieved with the
GetWorkUnitsoperation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.- Parameters:
startQueryPlanningRequest-- Returns:
- Result of the StartQueryPlanning operation returned by the service.
- See Also:
-
startQueryPlanning
default StartQueryPlanningResponse startQueryPlanning(Consumer<StartQueryPlanningRequest.Builder> startQueryPlanningRequest) throws InternalServiceException, InvalidInputException, AccessDeniedException, ThrottledException, AwsServiceException, SdkClientException, LakeFormationException Submits a request to process a query statement.
This operation generates work units that can be retrieved with the
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:
- Result of the StartQueryPlanning operation returned by the service.
- See Also:
-
startTransaction
default StartTransactionResponse startTransaction(StartTransactionRequest startTransactionRequest) throws InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
- Parameters:
startTransactionRequest-- Returns:
- Result of the StartTransaction operation returned by the service.
- See Also:
-
startTransaction
default StartTransactionResponse startTransaction(Consumer<StartTransactionRequest.Builder> startTransactionRequest) throws InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
This is a convenience which creates an instance of the
StartTransactionRequest.Builderavoiding the need to create one manually viaStartTransactionRequest.builder()- Parameters:
startTransactionRequest- AConsumerthat will call methods onStartTransactionRequest.Builderto create a request.- Returns:
- Result of the StartTransaction operation returned by the service.
- See Also:
-
updateDataCellsFilter
default UpdateDataCellsFilterResponse updateDataCellsFilter(UpdateDataCellsFilterRequest updateDataCellsFilterRequest) throws ConcurrentModificationException, InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Updates a data cell filter.
- Parameters:
updateDataCellsFilterRequest-- Returns:
- Result of the UpdateDataCellsFilter operation returned by the service.
- See Also:
-
updateDataCellsFilter
default UpdateDataCellsFilterResponse updateDataCellsFilter(Consumer<UpdateDataCellsFilterRequest.Builder> updateDataCellsFilterRequest) throws ConcurrentModificationException, InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Updates a data cell filter.
This is a convenience which creates an instance of the
UpdateDataCellsFilterRequest.Builderavoiding the need to create one manually viaUpdateDataCellsFilterRequest.builder()- Parameters:
updateDataCellsFilterRequest- AConsumerthat will call methods onUpdateDataCellsFilterRequest.Builderto create a request.- Returns:
- Result of the UpdateDataCellsFilter operation returned by the service.
- See Also:
-
updateLFTag
default UpdateLfTagResponse updateLFTag(UpdateLfTagRequest updateLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, ConcurrentModificationException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.
- Parameters:
updateLfTagRequest-- Returns:
- Result of the UpdateLFTag operation returned by the service.
- See Also:
-
updateLFTag
default UpdateLfTagResponse updateLFTag(Consumer<UpdateLfTagRequest.Builder> updateLfTagRequest) throws EntityNotFoundException, InvalidInputException, InternalServiceException, OperationTimeoutException, ConcurrentModificationException, AccessDeniedException, AwsServiceException, SdkClientException, LakeFormationException Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.
This is a convenience which creates an instance of the
UpdateLfTagRequest.Builderavoiding the need to create one manually viaUpdateLfTagRequest.builder()- Parameters:
updateLfTagRequest- AConsumerthat will call methods onUpdateLfTagRequest.Builderto create a request.- Returns:
- Result of the UpdateLFTag operation returned by the service.
- See Also:
-
updateLakeFormationIdentityCenterConfiguration
default UpdateLakeFormationIdentityCenterConfigurationResponse updateLakeFormationIdentityCenterConfiguration(UpdateLakeFormationIdentityCenterConfigurationRequest updateLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Updates the IAM Identity Center connection parameters.
- Parameters:
updateLakeFormationIdentityCenterConfigurationRequest-- Returns:
- Result of the UpdateLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
updateLakeFormationIdentityCenterConfiguration
default UpdateLakeFormationIdentityCenterConfigurationResponse updateLakeFormationIdentityCenterConfiguration(Consumer<UpdateLakeFormationIdentityCenterConfigurationRequest.Builder> updateLakeFormationIdentityCenterConfigurationRequest) throws InvalidInputException, EntityNotFoundException, InternalServiceException, OperationTimeoutException, AccessDeniedException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Updates the IAM Identity Center connection parameters.
This is a convenience which creates an instance of the
UpdateLakeFormationIdentityCenterConfigurationRequest.Builderavoiding the need to create one manually viaUpdateLakeFormationIdentityCenterConfigurationRequest.builder()- Parameters:
updateLakeFormationIdentityCenterConfigurationRequest- AConsumerthat will call methods onUpdateLakeFormationIdentityCenterConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateLakeFormationIdentityCenterConfiguration operation returned by the service.
- See Also:
-
updateResource
default UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
- Parameters:
updateResourceRequest-- Returns:
- Result of the UpdateResource operation returned by the service.
- See Also:
-
updateResource
default UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
This is a convenience which creates an instance of the
UpdateResourceRequest.Builderavoiding the need to create one manually viaUpdateResourceRequest.builder()- Parameters:
updateResourceRequest- AConsumerthat will call methods onUpdateResourceRequest.Builderto create a request.- Returns:
- Result of the UpdateResource operation returned by the service.
- See Also:
-
updateTableObjects
default UpdateTableObjectsResponse updateTableObjects(UpdateTableObjectsRequest updateTableObjectsRequest) throws InternalServiceException, InvalidInputException, OperationTimeoutException, EntityNotFoundException, TransactionCommittedException, TransactionCanceledException, TransactionCommitInProgressException, ResourceNotReadyException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Updates the manifest of Amazon S3 objects that make up the specified governed table.
- Parameters:
updateTableObjectsRequest-- Returns:
- Result of the UpdateTableObjects operation returned by the service.
- See Also:
-
updateTableObjects
default UpdateTableObjectsResponse updateTableObjects(Consumer<UpdateTableObjectsRequest.Builder> updateTableObjectsRequest) throws InternalServiceException, InvalidInputException, OperationTimeoutException, EntityNotFoundException, TransactionCommittedException, TransactionCanceledException, TransactionCommitInProgressException, ResourceNotReadyException, ConcurrentModificationException, AwsServiceException, SdkClientException, LakeFormationException Updates the manifest of Amazon S3 objects that make up the specified governed table.
This is a convenience which creates an instance of the
UpdateTableObjectsRequest.Builderavoiding the need to create one manually viaUpdateTableObjectsRequest.builder()- Parameters:
updateTableObjectsRequest- AConsumerthat will call methods onUpdateTableObjectsRequest.Builderto create a request.- Returns:
- Result of the UpdateTableObjects operation returned by the service.
- See Also:
-
updateTableStorageOptimizer
default UpdateTableStorageOptimizerResponse updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest updateTableStorageOptimizerRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException Updates the configuration of the storage optimizers for a table.
- Parameters:
updateTableStorageOptimizerRequest-- Returns:
- Result of the UpdateTableStorageOptimizer operation returned by the service.
- See Also:
-
updateTableStorageOptimizer
default UpdateTableStorageOptimizerResponse updateTableStorageOptimizer(Consumer<UpdateTableStorageOptimizerRequest.Builder> updateTableStorageOptimizerRequest) throws EntityNotFoundException, InvalidInputException, AccessDeniedException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException Updates the configuration of the storage optimizers for a table.
This is a convenience which creates an instance of the
UpdateTableStorageOptimizerRequest.Builderavoiding the need to create one manually viaUpdateTableStorageOptimizerRequest.builder()- Parameters:
updateTableStorageOptimizerRequest- AConsumerthat will call methods onUpdateTableStorageOptimizerRequest.Builderto create a request.- Returns:
- Result of the UpdateTableStorageOptimizer operation returned by the service.
- See Also:
-
create
Create aLakeFormationClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aLakeFormationClient. -
serviceMetadata
-
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
-