@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface LakeFormationAsyncClient extends SdkClient
builder() method.
Defines the public endpoint for the Lake Formation service.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AddLfTagsToResourceResponse> |
addLFTagsToResource(AddLfTagsToResourceRequest addLfTagsToResourceRequest)
Attaches one or more LF-tags to an existing resource.
|
default CompletableFuture<AddLfTagsToResourceResponse> |
addLFTagsToResource(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest)
Attaches one or more LF-tags to an existing resource.
|
default CompletableFuture<AssumeDecoratedRoleWithSamlResponse> |
assumeDecoratedRoleWithSAML(AssumeDecoratedRoleWithSamlRequest assumeDecoratedRoleWithSamlRequest)
Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the
request.
|
default CompletableFuture<AssumeDecoratedRoleWithSamlResponse> |
assumeDecoratedRoleWithSAML(Consumer<AssumeDecoratedRoleWithSamlRequest.Builder> assumeDecoratedRoleWithSamlRequest)
Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the
request.
|
default CompletableFuture<BatchGrantPermissionsResponse> |
batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
|
default CompletableFuture<BatchGrantPermissionsResponse> |
batchGrantPermissions(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
|
default CompletableFuture<BatchRevokePermissionsResponse> |
batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
|
default CompletableFuture<BatchRevokePermissionsResponse> |
batchRevokePermissions(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
|
static LakeFormationAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
LakeFormationAsyncClient. |
default CompletableFuture<CancelTransactionResponse> |
cancelTransaction(CancelTransactionRequest cancelTransactionRequest)
Attempts to cancel the specified transaction.
|
default CompletableFuture<CancelTransactionResponse> |
cancelTransaction(Consumer<CancelTransactionRequest.Builder> cancelTransactionRequest)
Attempts to cancel the specified transaction.
|
default CompletableFuture<CommitTransactionResponse> |
commitTransaction(CommitTransactionRequest commitTransactionRequest)
Attempts to commit the specified transaction.
|
default CompletableFuture<CommitTransactionResponse> |
commitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest)
Attempts to commit the specified transaction.
|
static LakeFormationAsyncClient |
create()
Create a
LakeFormationAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateDataCellsFilterResponse> |
createDataCellsFilter(Consumer<CreateDataCellsFilterRequest.Builder> createDataCellsFilterRequest)
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
|
default CompletableFuture<CreateDataCellsFilterResponse> |
createDataCellsFilter(CreateDataCellsFilterRequest createDataCellsFilterRequest)
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
|
default CompletableFuture<CreateLfTagResponse> |
createLFTag(Consumer<CreateLfTagRequest.Builder> createLfTagRequest)
Creates an LF-tag with the specified name and values.
|
default CompletableFuture<CreateLfTagResponse> |
createLFTag(CreateLfTagRequest createLfTagRequest)
Creates an LF-tag with the specified name and values.
|
default CompletableFuture<DeleteDataCellsFilterResponse> |
deleteDataCellsFilter(Consumer<DeleteDataCellsFilterRequest.Builder> deleteDataCellsFilterRequest)
Deletes a data cell filter.
|
default CompletableFuture<DeleteDataCellsFilterResponse> |
deleteDataCellsFilter(DeleteDataCellsFilterRequest deleteDataCellsFilterRequest)
Deletes a data cell filter.
|
default CompletableFuture<DeleteLfTagResponse> |
deleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest)
Deletes the specified LF-tag given a key name.
|
default CompletableFuture<DeleteLfTagResponse> |
deleteLFTag(DeleteLfTagRequest deleteLfTagRequest)
Deletes the specified LF-tag given a key name.
|
default CompletableFuture<DeleteObjectsOnCancelResponse> |
deleteObjectsOnCancel(Consumer<DeleteObjectsOnCancelRequest.Builder> deleteObjectsOnCancelRequest)
For a specific governed table, provides a list of Amazon S3 objects that will be written during the current
transaction and that can be automatically deleted if the transaction is canceled.
|
default CompletableFuture<DeleteObjectsOnCancelResponse> |
deleteObjectsOnCancel(DeleteObjectsOnCancelRequest deleteObjectsOnCancelRequest)
For a specific governed table, provides a list of Amazon S3 objects that will be written during the current
transaction and that can be automatically deleted if the transaction is canceled.
|
default CompletableFuture<DeregisterResourceResponse> |
deregisterResource(Consumer<DeregisterResourceRequest.Builder> deregisterResourceRequest)
Deregisters the resource as managed by the Data Catalog.
|
default CompletableFuture<DeregisterResourceResponse> |
deregisterResource(DeregisterResourceRequest deregisterResourceRequest)
Deregisters the resource as managed by the Data Catalog.
|
default CompletableFuture<DescribeResourceResponse> |
describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)
Retrieves the current data access role for the given resource registered in Lake Formation.
|
default CompletableFuture<DescribeResourceResponse> |
describeResource(DescribeResourceRequest describeResourceRequest)
Retrieves the current data access role for the given resource registered in Lake Formation.
|
default CompletableFuture<DescribeTransactionResponse> |
describeTransaction(Consumer<DescribeTransactionRequest.Builder> describeTransactionRequest)
Returns the details of a single transaction.
|
default CompletableFuture<DescribeTransactionResponse> |
describeTransaction(DescribeTransactionRequest describeTransactionRequest)
Returns the details of a single transaction.
|
default CompletableFuture<ExtendTransactionResponse> |
extendTransaction(Consumer<ExtendTransactionRequest.Builder> extendTransactionRequest)
Indicates to the service that the specified transaction is still active and should not be treated as idle and
aborted.
|
default CompletableFuture<ExtendTransactionResponse> |
extendTransaction(ExtendTransactionRequest extendTransactionRequest)
Indicates to the service that the specified transaction is still active and should not be treated as idle and
aborted.
|
default CompletableFuture<GetDataLakeSettingsResponse> |
getDataLakeSettings(Consumer<GetDataLakeSettingsRequest.Builder> getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
|
default CompletableFuture<GetDataLakeSettingsResponse> |
getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
|
default CompletableFuture<GetEffectivePermissionsForPathResponse> |
getEffectivePermissionsForPath(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
default CompletableFuture<GetEffectivePermissionsForPathResponse> |
getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
default GetEffectivePermissionsForPathPublisher |
getEffectivePermissionsForPathPaginator(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
default GetEffectivePermissionsForPathPublisher |
getEffectivePermissionsForPathPaginator(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
default CompletableFuture<GetLfTagResponse> |
getLFTag(Consumer<GetLfTagRequest.Builder> getLfTagRequest)
Returns an LF-tag definition.
|
default CompletableFuture<GetLfTagResponse> |
getLFTag(GetLfTagRequest getLfTagRequest)
Returns an LF-tag definition.
|
default CompletableFuture<GetQueryStateResponse> |
getQueryState(Consumer<GetQueryStateRequest.Builder> getQueryStateRequest)
Returns the state of a query previously submitted.
|
default CompletableFuture<GetQueryStateResponse> |
getQueryState(GetQueryStateRequest getQueryStateRequest)
Returns the state of a query previously submitted.
|
default CompletableFuture<GetQueryStatisticsResponse> |
getQueryStatistics(Consumer<GetQueryStatisticsRequest.Builder> getQueryStatisticsRequest)
Retrieves statistics on the planning and execution of a query.
|
default CompletableFuture<GetQueryStatisticsResponse> |
getQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest)
Retrieves statistics on the planning and execution of a query.
|
default CompletableFuture<GetResourceLfTagsResponse> |
getResourceLFTags(Consumer<GetResourceLfTagsRequest.Builder> getResourceLfTagsRequest)
Returns the LF-tags applied to a resource.
|
default CompletableFuture<GetResourceLfTagsResponse> |
getResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest)
Returns the LF-tags applied to a resource.
|
default CompletableFuture<GetTableObjectsResponse> |
getTableObjects(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table.
|
default CompletableFuture<GetTableObjectsResponse> |
getTableObjects(GetTableObjectsRequest getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table.
|
default GetTableObjectsPublisher |
getTableObjectsPaginator(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table.
|
default GetTableObjectsPublisher |
getTableObjectsPaginator(GetTableObjectsRequest getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table.
|
default CompletableFuture<GetTemporaryGluePartitionCredentialsResponse> |
getTemporaryGluePartitionCredentials(Consumer<GetTemporaryGluePartitionCredentialsRequest.Builder> getTemporaryGluePartitionCredentialsRequest)
This API is identical to
GetTemporaryTableCredentials except that this is used when the target Data
Catalog resource is of type Partition. |
default CompletableFuture<GetTemporaryGluePartitionCredentialsResponse> |
getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest getTemporaryGluePartitionCredentialsRequest)
This API is identical to
GetTemporaryTableCredentials except that this is used when the target Data
Catalog resource is of type Partition. |
default CompletableFuture<GetTemporaryGlueTableCredentialsResponse> |
getTemporaryGlueTableCredentials(Consumer<GetTemporaryGlueTableCredentialsRequest.Builder> getTemporaryGlueTableCredentialsRequest)
Allows a caller in a secure environment to assume a role with permission to access Amazon S3.
|
default CompletableFuture<GetTemporaryGlueTableCredentialsResponse> |
getTemporaryGlueTableCredentials(GetTemporaryGlueTableCredentialsRequest getTemporaryGlueTableCredentialsRequest)
Allows a caller in a secure environment to assume a role with permission to access Amazon S3.
|
default <ReturnT> CompletableFuture<ReturnT> |
getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest,
AsyncResponseTransformer<GetWorkUnitResultsResponse,ReturnT> asyncResponseTransformer)
Returns the work units resulting from the query.
|
default CompletableFuture<GetWorkUnitResultsResponse> |
getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest,
Path destinationPath)
Returns the work units resulting from the query.
|
default <ReturnT> CompletableFuture<ReturnT> |
getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest,
AsyncResponseTransformer<GetWorkUnitResultsResponse,ReturnT> asyncResponseTransformer)
Returns the work units resulting from the query.
|
default CompletableFuture<GetWorkUnitResultsResponse> |
getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest,
Path destinationPath)
Returns the work units resulting from the query.
|
default CompletableFuture<GetWorkUnitsResponse> |
getWorkUnits(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest)
Retrieves the work units generated by the
StartQueryPlanning operation. |
default CompletableFuture<GetWorkUnitsResponse> |
getWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest)
Retrieves the work units generated by the
StartQueryPlanning operation. |
default GetWorkUnitsPublisher |
getWorkUnitsPaginator(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest)
Retrieves the work units generated by the
StartQueryPlanning operation. |
default GetWorkUnitsPublisher |
getWorkUnitsPaginator(GetWorkUnitsRequest getWorkUnitsRequest)
Retrieves the work units generated by the
StartQueryPlanning operation. |
default CompletableFuture<GrantPermissionsResponse> |
grantPermissions(Consumer<GrantPermissionsRequest.Builder> grantPermissionsRequest)
Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data
storage such as Amazon S3.
|
default CompletableFuture<GrantPermissionsResponse> |
grantPermissions(GrantPermissionsRequest grantPermissionsRequest)
Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data
storage such as Amazon S3.
|
default CompletableFuture<ListDataCellsFilterResponse> |
listDataCellsFilter(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest)
Lists all the data cell filters on a table.
|
default CompletableFuture<ListDataCellsFilterResponse> |
listDataCellsFilter(ListDataCellsFilterRequest listDataCellsFilterRequest)
Lists all the data cell filters on a table.
|
default ListDataCellsFilterPublisher |
listDataCellsFilterPaginator(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest)
Lists all the data cell filters on a table.
|
default ListDataCellsFilterPublisher |
listDataCellsFilterPaginator(ListDataCellsFilterRequest listDataCellsFilterRequest)
Lists all the data cell filters on a table.
|
default CompletableFuture<ListLfTagsResponse> |
listLFTags(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
|
default CompletableFuture<ListLfTagsResponse> |
listLFTags(ListLfTagsRequest listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
|
default ListLFTagsPublisher |
listLFTagsPaginator(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
|
default ListLFTagsPublisher |
listLFTagsPaginator(ListLfTagsRequest listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
|
default CompletableFuture<ListPermissionsResponse> |
listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default CompletableFuture<ListPermissionsResponse> |
listPermissions(ListPermissionsRequest listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default ListPermissionsPublisher |
listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default ListPermissionsPublisher |
listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default CompletableFuture<ListResourcesResponse> |
listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default CompletableFuture<ListResourcesResponse> |
listResources(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default ListResourcesPublisher |
listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default ListResourcesPublisher |
listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default CompletableFuture<ListTableStorageOptimizersResponse> |
listTableStorageOptimizers(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
|
default CompletableFuture<ListTableStorageOptimizersResponse> |
listTableStorageOptimizers(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
|
default ListTableStorageOptimizersPublisher |
listTableStorageOptimizersPaginator(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
|
default ListTableStorageOptimizersPublisher |
listTableStorageOptimizersPaginator(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
|
default CompletableFuture<ListTransactionsResponse> |
listTransactions(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest)
Returns metadata about transactions and their status.
|
default CompletableFuture<ListTransactionsResponse> |
listTransactions(ListTransactionsRequest listTransactionsRequest)
Returns metadata about transactions and their status.
|
default ListTransactionsPublisher |
listTransactionsPaginator(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest)
Returns metadata about transactions and their status.
|
default ListTransactionsPublisher |
listTransactionsPaginator(ListTransactionsRequest listTransactionsRequest)
Returns metadata about transactions and their status.
|
default CompletableFuture<PutDataLakeSettingsResponse> |
putDataLakeSettings(Consumer<PutDataLakeSettingsRequest.Builder> putDataLakeSettingsRequest)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
|
default CompletableFuture<PutDataLakeSettingsResponse> |
putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
|
default CompletableFuture<RegisterResourceResponse> |
registerResource(Consumer<RegisterResourceRequest.Builder> registerResourceRequest)
Registers the resource as managed by the Data Catalog.
|
default CompletableFuture<RegisterResourceResponse> |
registerResource(RegisterResourceRequest registerResourceRequest)
Registers the resource as managed by the Data Catalog.
|
default CompletableFuture<RemoveLfTagsFromResourceResponse> |
removeLFTagsFromResource(Consumer<RemoveLfTagsFromResourceRequest.Builder> removeLfTagsFromResourceRequest)
Removes an LF-tag from the resource.
|
default CompletableFuture<RemoveLfTagsFromResourceResponse> |
removeLFTagsFromResource(RemoveLfTagsFromResourceRequest removeLfTagsFromResourceRequest)
Removes an LF-tag from the resource.
|
default CompletableFuture<RevokePermissionsResponse> |
revokePermissions(Consumer<RevokePermissionsRequest.Builder> revokePermissionsRequest)
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data
storage such as Amazon S3.
|
default CompletableFuture<RevokePermissionsResponse> |
revokePermissions(RevokePermissionsRequest revokePermissionsRequest)
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data
storage such as Amazon S3.
|
default CompletableFuture<SearchDatabasesByLfTagsResponse> |
searchDatabasesByLFTags(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest)
This operation allows a search on
DATABASE resources by TagCondition. |
default CompletableFuture<SearchDatabasesByLfTagsResponse> |
searchDatabasesByLFTags(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest)
This operation allows a search on
DATABASE resources by TagCondition. |
default SearchDatabasesByLFTagsPublisher |
searchDatabasesByLFTagsPaginator(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest)
This operation allows a search on
DATABASE resources by TagCondition. |
default SearchDatabasesByLFTagsPublisher |
searchDatabasesByLFTagsPaginator(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest)
This operation allows a search on
DATABASE resources by TagCondition. |
default CompletableFuture<SearchTablesByLfTagsResponse> |
searchTablesByLFTags(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest)
This operation allows a search on
TABLE resources by LFTags. |
default CompletableFuture<SearchTablesByLfTagsResponse> |
searchTablesByLFTags(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest)
This operation allows a search on
TABLE resources by LFTags. |
default SearchTablesByLFTagsPublisher |
searchTablesByLFTagsPaginator(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest)
This operation allows a search on
TABLE resources by LFTags. |
default SearchTablesByLFTagsPublisher |
searchTablesByLFTagsPaginator(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest)
This operation allows a search on
TABLE resources by LFTags. |
default CompletableFuture<StartQueryPlanningResponse> |
startQueryPlanning(Consumer<StartQueryPlanningRequest.Builder> startQueryPlanningRequest)
Submits a request to process a query statement.
|
default CompletableFuture<StartQueryPlanningResponse> |
startQueryPlanning(StartQueryPlanningRequest startQueryPlanningRequest)
Submits a request to process a query statement.
|
default CompletableFuture<StartTransactionResponse> |
startTransaction(Consumer<StartTransactionRequest.Builder> startTransactionRequest)
Starts a new transaction and returns its transaction ID.
|
default CompletableFuture<StartTransactionResponse> |
startTransaction(StartTransactionRequest startTransactionRequest)
Starts a new transaction and returns its transaction ID.
|
default CompletableFuture<UpdateLfTagResponse> |
updateLFTag(Consumer<UpdateLfTagRequest.Builder> updateLfTagRequest)
Updates the list of possible values for the specified LF-tag key.
|
default CompletableFuture<UpdateLfTagResponse> |
updateLFTag(UpdateLfTagRequest updateLfTagRequest)
Updates the list of possible values for the specified LF-tag key.
|
default CompletableFuture<UpdateResourceResponse> |
updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
|
default CompletableFuture<UpdateResourceResponse> |
updateResource(UpdateResourceRequest updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
|
default CompletableFuture<UpdateTableObjectsResponse> |
updateTableObjects(Consumer<UpdateTableObjectsRequest.Builder> updateTableObjectsRequest)
Updates the manifest of Amazon S3 objects that make up the specified governed table.
|
default CompletableFuture<UpdateTableObjectsResponse> |
updateTableObjects(UpdateTableObjectsRequest updateTableObjectsRequest)
Updates the manifest of Amazon S3 objects that make up the specified governed table.
|
default CompletableFuture<UpdateTableStorageOptimizerResponse> |
updateTableStorageOptimizer(Consumer<UpdateTableStorageOptimizerRequest.Builder> updateTableStorageOptimizerRequest)
Updates the configuration of the storage optimizers for a table.
|
default CompletableFuture<UpdateTableStorageOptimizerResponse> |
updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest updateTableStorageOptimizerRequest)
Updates the configuration of the storage optimizers for a table.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AddLfTagsToResourceResponse> addLFTagsToResource(AddLfTagsToResourceRequest addLfTagsToResourceRequest)
Attaches one or more LF-tags to an existing resource.
addLfTagsToResourceRequest - default CompletableFuture<AddLfTagsToResourceResponse> addLFTagsToResource(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest)
Attaches one or more LF-tags to an existing resource.
This is a convenience which creates an instance of the AddLfTagsToResourceRequest.Builder avoiding the
need to create one manually via AddLfTagsToResourceRequest.builder()
addLfTagsToResourceRequest - A Consumer that will call methods on AddLFTagsToResourceRequest.Builder to create a
request.default CompletableFuture<AssumeDecoratedRoleWithSamlResponse> assumeDecoratedRoleWithSAML(AssumeDecoratedRoleWithSamlRequest assumeDecoratedRoleWithSamlRequest)
Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.
This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which
is authorized via the virtual API GetDataAccess. Therefore, all SAML roles that can be assumed via
AssumeDecoratedRoleWithSAML must at a minimum include lakeformation:GetDataAccess in
their role policies. A typical IAM policy attached to such a role would look as follows:
assumeDecoratedRoleWithSamlRequest - default CompletableFuture<AssumeDecoratedRoleWithSamlResponse> assumeDecoratedRoleWithSAML(Consumer<AssumeDecoratedRoleWithSamlRequest.Builder> assumeDecoratedRoleWithSamlRequest)
Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.
This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which
is authorized via the virtual API GetDataAccess. Therefore, all SAML roles that can be assumed via
AssumeDecoratedRoleWithSAML must at a minimum include lakeformation:GetDataAccess in
their role policies. A typical IAM policy attached to such a role would look as follows:
This is a convenience which creates an instance of the AssumeDecoratedRoleWithSamlRequest.Builder
avoiding the need to create one manually via AssumeDecoratedRoleWithSamlRequest.builder()
assumeDecoratedRoleWithSamlRequest - A Consumer that will call methods on AssumeDecoratedRoleWithSAMLRequest.Builder to create
a request.default CompletableFuture<BatchGrantPermissionsResponse> batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
batchGrantPermissionsRequest - default CompletableFuture<BatchGrantPermissionsResponse> batchGrantPermissions(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
This is a convenience which creates an instance of the BatchGrantPermissionsRequest.Builder avoiding the
need to create one manually via BatchGrantPermissionsRequest.builder()
batchGrantPermissionsRequest - A Consumer that will call methods on BatchGrantPermissionsRequest.Builder to create a
request.default CompletableFuture<BatchRevokePermissionsResponse> batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
batchRevokePermissionsRequest - default CompletableFuture<BatchRevokePermissionsResponse> batchRevokePermissions(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
This is a convenience which creates an instance of the BatchRevokePermissionsRequest.Builder avoiding the
need to create one manually via BatchRevokePermissionsRequest.builder()
batchRevokePermissionsRequest - A Consumer that will call methods on BatchRevokePermissionsRequest.Builder to create a
request.default CompletableFuture<CancelTransactionResponse> cancelTransaction(CancelTransactionRequest cancelTransactionRequest)
Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
cancelTransactionRequest - UpdateTableObjects.default CompletableFuture<CancelTransactionResponse> cancelTransaction(Consumer<CancelTransactionRequest.Builder> cancelTransactionRequest)
Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
This is a convenience which creates an instance of the CancelTransactionRequest.Builder avoiding the need
to create one manually via CancelTransactionRequest.builder()
cancelTransactionRequest - A Consumer that will call methods on CancelTransactionRequest.Builder to create a request.UpdateTableObjects.default CompletableFuture<CommitTransactionResponse> commitTransaction(CommitTransactionRequest commitTransactionRequest)
Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.
commitTransactionRequest - default CompletableFuture<CommitTransactionResponse> commitTransaction(Consumer<CommitTransactionRequest.Builder> commitTransactionRequest)
Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.
This is a convenience which creates an instance of the CommitTransactionRequest.Builder avoiding the need
to create one manually via CommitTransactionRequest.builder()
commitTransactionRequest - A Consumer that will call methods on CommitTransactionRequest.Builder to create a request.default CompletableFuture<CreateDataCellsFilterResponse> createDataCellsFilter(CreateDataCellsFilterRequest createDataCellsFilterRequest)
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
createDataCellsFilterRequest - default CompletableFuture<CreateDataCellsFilterResponse> createDataCellsFilter(Consumer<CreateDataCellsFilterRequest.Builder> createDataCellsFilterRequest)
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
This is a convenience which creates an instance of the CreateDataCellsFilterRequest.Builder avoiding the
need to create one manually via CreateDataCellsFilterRequest.builder()
createDataCellsFilterRequest - A Consumer that will call methods on CreateDataCellsFilterRequest.Builder to create a
request.default CompletableFuture<CreateLfTagResponse> createLFTag(CreateLfTagRequest createLfTagRequest)
Creates an LF-tag with the specified name and values.
createLfTagRequest - default CompletableFuture<CreateLfTagResponse> createLFTag(Consumer<CreateLfTagRequest.Builder> createLfTagRequest)
Creates an LF-tag with the specified name and values.
This is a convenience which creates an instance of the CreateLfTagRequest.Builder avoiding the need to
create one manually via CreateLfTagRequest.builder()
createLfTagRequest - A Consumer that will call methods on CreateLFTagRequest.Builder to create a request.default CompletableFuture<DeleteDataCellsFilterResponse> deleteDataCellsFilter(DeleteDataCellsFilterRequest deleteDataCellsFilterRequest)
Deletes a data cell filter.
deleteDataCellsFilterRequest - default CompletableFuture<DeleteDataCellsFilterResponse> deleteDataCellsFilter(Consumer<DeleteDataCellsFilterRequest.Builder> deleteDataCellsFilterRequest)
Deletes a data cell filter.
This is a convenience which creates an instance of the DeleteDataCellsFilterRequest.Builder avoiding the
need to create one manually via DeleteDataCellsFilterRequest.builder()
deleteDataCellsFilterRequest - A Consumer that will call methods on DeleteDataCellsFilterRequest.Builder to create a
request.default CompletableFuture<DeleteLfTagResponse> deleteLFTag(DeleteLfTagRequest deleteLfTagRequest)
Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation
will throw an exception. When you delete an LF-tag, the LFTagPolicy attached to the LF-tag becomes
invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag
will no longer be applied to the resource.
deleteLfTagRequest - default CompletableFuture<DeleteLfTagResponse> deleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest)
Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation
will throw an exception. When you delete an LF-tag, the LFTagPolicy attached to the LF-tag becomes
invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF-tag
will no longer be applied to the resource.
This is a convenience which creates an instance of the DeleteLfTagRequest.Builder avoiding the need to
create one manually via DeleteLfTagRequest.builder()
deleteLfTagRequest - A Consumer that will call methods on DeleteLFTagRequest.Builder to create a request.default CompletableFuture<DeleteObjectsOnCancelResponse> deleteObjectsOnCancel(DeleteObjectsOnCancelRequest deleteObjectsOnCancelRequest)
For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.
The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically
call DeleteObjectsOnCancel before writes. For more information, see Rolling Back Amazon S3 Writes.
deleteObjectsOnCancelRequest - UpdateTableObjects.default CompletableFuture<DeleteObjectsOnCancelResponse> deleteObjectsOnCancel(Consumer<DeleteObjectsOnCancelRequest.Builder> deleteObjectsOnCancelRequest)
For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.
The Glue ETL library function write_dynamic_frame.from_catalog() includes an option to automatically
call DeleteObjectsOnCancel before writes. For more information, see Rolling Back Amazon S3 Writes.
This is a convenience which creates an instance of the DeleteObjectsOnCancelRequest.Builder avoiding the
need to create one manually via DeleteObjectsOnCancelRequest.builder()
deleteObjectsOnCancelRequest - A Consumer that will call methods on DeleteObjectsOnCancelRequest.Builder to create a
request.UpdateTableObjects.default CompletableFuture<DeregisterResourceResponse> deregisterResource(DeregisterResourceRequest deregisterResourceRequest)
Deregisters the resource as managed by the Data Catalog.
When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
deregisterResourceRequest - default CompletableFuture<DeregisterResourceResponse> deregisterResource(Consumer<DeregisterResourceRequest.Builder> deregisterResourceRequest)
Deregisters the resource as managed by the Data Catalog.
When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
This is a convenience which creates an instance of the DeregisterResourceRequest.Builder avoiding the
need to create one manually via DeregisterResourceRequest.builder()
deregisterResourceRequest - A Consumer that will call methods on DeregisterResourceRequest.Builder to create a
request.default CompletableFuture<DescribeResourceResponse> describeResource(DescribeResourceRequest describeResourceRequest)
Retrieves the current data access role for the given resource registered in Lake Formation.
describeResourceRequest - default CompletableFuture<DescribeResourceResponse> describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)
Retrieves the current data access role for the given resource registered in Lake Formation.
This is a convenience which creates an instance of the DescribeResourceRequest.Builder avoiding the need
to create one manually via DescribeResourceRequest.builder()
describeResourceRequest - A Consumer that will call methods on DescribeResourceRequest.Builder to create a request.default CompletableFuture<DescribeTransactionResponse> describeTransaction(DescribeTransactionRequest describeTransactionRequest)
Returns the details of a single transaction.
describeTransactionRequest - default CompletableFuture<DescribeTransactionResponse> describeTransaction(Consumer<DescribeTransactionRequest.Builder> describeTransactionRequest)
Returns the details of a single transaction.
This is a convenience which creates an instance of the DescribeTransactionRequest.Builder avoiding the
need to create one manually via DescribeTransactionRequest.builder()
describeTransactionRequest - A Consumer that will call methods on DescribeTransactionRequest.Builder to create a
request.default CompletableFuture<ExtendTransactionResponse> extendTransaction(ExtendTransactionRequest extendTransactionRequest)
Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.
extendTransactionRequest - UpdateTableObjects.default CompletableFuture<ExtendTransactionResponse> extendTransaction(Consumer<ExtendTransactionRequest.Builder> extendTransactionRequest)
Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.
This is a convenience which creates an instance of the ExtendTransactionRequest.Builder avoiding the need
to create one manually via ExtendTransactionRequest.builder()
extendTransactionRequest - A Consumer that will call methods on ExtendTransactionRequest.Builder to create a request.UpdateTableObjects.default CompletableFuture<GetDataLakeSettingsResponse> getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getDataLakeSettingsRequest - default CompletableFuture<GetDataLakeSettingsResponse> getDataLakeSettings(Consumer<GetDataLakeSettingsRequest.Builder> getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
This is a convenience which creates an instance of the GetDataLakeSettingsRequest.Builder avoiding the
need to create one manually via GetDataLakeSettingsRequest.builder()
getDataLakeSettingsRequest - A Consumer that will call methods on GetDataLakeSettingsRequest.Builder to create a
request.default CompletableFuture<GetEffectivePermissionsForPathResponse> getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.
getEffectivePermissionsForPathRequest - default CompletableFuture<GetEffectivePermissionsForPathResponse> getEffectivePermissionsForPath(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.
This is a convenience which creates an instance of the GetEffectivePermissionsForPathRequest.Builder
avoiding the need to create one manually via GetEffectivePermissionsForPathRequest.builder()
getEffectivePermissionsForPathRequest - A Consumer that will call methods on GetEffectivePermissionsForPathRequest.Builder to
create a request.default GetEffectivePermissionsForPathPublisher getEffectivePermissionsForPathPaginator(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.
This is a variant of
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathPublisher publisher = client.getEffectivePermissionsForPathPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathPublisher publisher = client.getEffectivePermissionsForPathPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation.
getEffectivePermissionsForPathRequest - default GetEffectivePermissionsForPathPublisher getEffectivePermissionsForPathPaginator(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.
This is a variant of
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathPublisher publisher = client.getEffectivePermissionsForPathPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathPublisher publisher = client.getEffectivePermissionsForPathPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation.
This is a convenience which creates an instance of the GetEffectivePermissionsForPathRequest.Builder
avoiding the need to create one manually via GetEffectivePermissionsForPathRequest.builder()
getEffectivePermissionsForPathRequest - A Consumer that will call methods on GetEffectivePermissionsForPathRequest.Builder to
create a request.default CompletableFuture<GetLfTagResponse> getLFTag(GetLfTagRequest getLfTagRequest)
Returns an LF-tag definition.
getLfTagRequest - default CompletableFuture<GetLfTagResponse> getLFTag(Consumer<GetLfTagRequest.Builder> getLfTagRequest)
Returns an LF-tag definition.
This is a convenience which creates an instance of the GetLfTagRequest.Builder avoiding the need to
create one manually via GetLfTagRequest.builder()
getLfTagRequest - A Consumer that will call methods on GetLFTagRequest.Builder to create a request.default CompletableFuture<GetQueryStateResponse> getQueryState(GetQueryStateRequest getQueryStateRequest)
Returns the state of a query previously submitted. Clients are expected to poll GetQueryState to
monitor the current state of the planning before retrieving the work units. A query state is only visible to the
principal that made the initial call to StartQueryPlanning.
getQueryStateRequest - default CompletableFuture<GetQueryStateResponse> getQueryState(Consumer<GetQueryStateRequest.Builder> getQueryStateRequest)
Returns the state of a query previously submitted. Clients are expected to poll GetQueryState to
monitor the current state of the planning before retrieving the work units. A query state is only visible to the
principal that made the initial call to StartQueryPlanning.
This is a convenience which creates an instance of the GetQueryStateRequest.Builder avoiding the need to
create one manually via GetQueryStateRequest.builder()
getQueryStateRequest - A Consumer that will call methods on GetQueryStateRequest.Builder to create a request.default CompletableFuture<GetQueryStatisticsResponse> getQueryStatistics(GetQueryStatisticsRequest getQueryStatisticsRequest)
Retrieves statistics on the planning and execution of a query.
getQueryStatisticsRequest - default CompletableFuture<GetQueryStatisticsResponse> getQueryStatistics(Consumer<GetQueryStatisticsRequest.Builder> getQueryStatisticsRequest)
Retrieves statistics on the planning and execution of a query.
This is a convenience which creates an instance of the GetQueryStatisticsRequest.Builder avoiding the
need to create one manually via GetQueryStatisticsRequest.builder()
getQueryStatisticsRequest - A Consumer that will call methods on GetQueryStatisticsRequest.Builder to create a
request.default CompletableFuture<GetResourceLfTagsResponse> getResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest)
Returns the LF-tags applied to a resource.
getResourceLfTagsRequest - default CompletableFuture<GetResourceLfTagsResponse> getResourceLFTags(Consumer<GetResourceLfTagsRequest.Builder> getResourceLfTagsRequest)
Returns the LF-tags applied to a resource.
This is a convenience which creates an instance of the GetResourceLfTagsRequest.Builder avoiding the need
to create one manually via GetResourceLfTagsRequest.builder()
getResourceLfTagsRequest - A Consumer that will call methods on GetResourceLFTagsRequest.Builder to create a request.default CompletableFuture<GetTableObjectsResponse> getTableObjects(GetTableObjectsRequest getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
getTableObjectsRequest - UpdateTableObjects.default CompletableFuture<GetTableObjectsResponse> getTableObjects(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
This is a convenience which creates an instance of the GetTableObjectsRequest.Builder avoiding the need
to create one manually via GetTableObjectsRequest.builder()
getTableObjectsRequest - A Consumer that will call methods on GetTableObjectsRequest.Builder to create a request.UpdateTableObjects.default GetTableObjectsPublisher getTableObjectsPaginator(GetTableObjectsRequest getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
This is a variant of
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsPublisher publisher = client.getTableObjectsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsPublisher publisher = client.getTableObjectsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)
operation.
getTableObjectsRequest - UpdateTableObjects.default GetTableObjectsPublisher getTableObjectsPaginator(Consumer<GetTableObjectsRequest.Builder> getTableObjectsRequest)
Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
This is a variant of
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsPublisher publisher = client.getTableObjectsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.GetTableObjectsPublisher publisher = client.getTableObjectsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTableObjects(software.amazon.awssdk.services.lakeformation.model.GetTableObjectsRequest)
operation.
This is a convenience which creates an instance of the GetTableObjectsRequest.Builder avoiding the need
to create one manually via GetTableObjectsRequest.builder()
getTableObjectsRequest - A Consumer that will call methods on GetTableObjectsRequest.Builder to create a request.UpdateTableObjects.default CompletableFuture<GetTemporaryGluePartitionCredentialsResponse> getTemporaryGluePartitionCredentials(GetTemporaryGluePartitionCredentialsRequest getTemporaryGluePartitionCredentialsRequest)
This API is identical to GetTemporaryTableCredentials except that this is used when the target Data
Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the
same scope down policy which restricts access to a single Amazon S3 prefix.
getTemporaryGluePartitionCredentialsRequest - GetTemporaryGlueTableCredentials operation with
SupportedPermissionType equal to ColumnPermission, but cell-level permissions
exist on the table, this exception is thrown.default CompletableFuture<GetTemporaryGluePartitionCredentialsResponse> getTemporaryGluePartitionCredentials(Consumer<GetTemporaryGluePartitionCredentialsRequest.Builder> getTemporaryGluePartitionCredentialsRequest)
This API is identical to GetTemporaryTableCredentials except that this is used when the target Data
Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the
same scope down policy which restricts access to a single Amazon S3 prefix.
This is a convenience which creates an instance of the
GetTemporaryGluePartitionCredentialsRequest.Builder avoiding the need to create one manually via
GetTemporaryGluePartitionCredentialsRequest.builder()
getTemporaryGluePartitionCredentialsRequest - A Consumer that will call methods on GetTemporaryGluePartitionCredentialsRequest.Builder
to create a request.GetTemporaryGlueTableCredentials operation with
SupportedPermissionType equal to ColumnPermission, but cell-level permissions
exist on the table, this exception is thrown.default CompletableFuture<GetTemporaryGlueTableCredentialsResponse> getTemporaryGlueTableCredentials(GetTemporaryGlueTableCredentialsRequest getTemporaryGlueTableCredentialsRequest)
Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
getTemporaryGlueTableCredentialsRequest - GetTemporaryGlueTableCredentials operation with
SupportedPermissionType equal to ColumnPermission, but cell-level permissions
exist on the table, this exception is thrown.default CompletableFuture<GetTemporaryGlueTableCredentialsResponse> getTemporaryGlueTableCredentials(Consumer<GetTemporaryGlueTableCredentialsRequest.Builder> getTemporaryGlueTableCredentialsRequest)
Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
This is a convenience which creates an instance of the GetTemporaryGlueTableCredentialsRequest.Builder
avoiding the need to create one manually via GetTemporaryGlueTableCredentialsRequest.builder()
getTemporaryGlueTableCredentialsRequest - A Consumer that will call methods on GetTemporaryGlueTableCredentialsRequest.Builder to
create a request.GetTemporaryGlueTableCredentials operation with
SupportedPermissionType equal to ColumnPermission, but cell-level permissions
exist on the table, this exception is thrown.default <ReturnT> CompletableFuture<ReturnT> getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, AsyncResponseTransformer<GetWorkUnitResultsResponse,ReturnT> asyncResponseTransformer)
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
getWorkUnitResultsRequest - asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
default <ReturnT> CompletableFuture<ReturnT> getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, AsyncResponseTransformer<GetWorkUnitResultsResponse,ReturnT> asyncResponseTransformer)
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
This is a convenience which creates an instance of the GetWorkUnitResultsRequest.Builder avoiding the
need to create one manually via GetWorkUnitResultsRequest.builder()
getWorkUnitResultsRequest - A Consumer that will call methods on GetWorkUnitResultsRequest.Builder to create a
request.asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
default CompletableFuture<GetWorkUnitResultsResponse> getWorkUnitResults(GetWorkUnitResultsRequest getWorkUnitResultsRequest, Path destinationPath)
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
getWorkUnitResultsRequest - destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
default CompletableFuture<GetWorkUnitResultsResponse> getWorkUnitResults(Consumer<GetWorkUnitResultsRequest.Builder> getWorkUnitResultsRequest, Path destinationPath)
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
This is a convenience which creates an instance of the GetWorkUnitResultsRequest.Builder avoiding the
need to create one manually via GetWorkUnitResultsRequest.builder()
getWorkUnitResultsRequest - A Consumer that will call methods on GetWorkUnitResultsRequest.Builder to create a
request.destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0
messages.
default CompletableFuture<GetWorkUnitsResponse> getWorkUnits(GetWorkUnitsRequest getWorkUnitsRequest)
Retrieves the work units generated by the StartQueryPlanning operation.
getWorkUnitsRequest - default CompletableFuture<GetWorkUnitsResponse> getWorkUnits(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest)
Retrieves the work units generated by the StartQueryPlanning operation.
This is a convenience which creates an instance of the GetWorkUnitsRequest.Builder avoiding the need to
create one manually via GetWorkUnitsRequest.builder()
getWorkUnitsRequest - A Consumer that will call methods on GetWorkUnitsRequest.Builder to create a request.default GetWorkUnitsPublisher getWorkUnitsPaginator(GetWorkUnitsRequest getWorkUnitsRequest)
Retrieves the work units generated by the StartQueryPlanning operation.
This is a variant of
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsPublisher publisher = client.getWorkUnitsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsPublisher publisher = client.getWorkUnitsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest) operation.
getWorkUnitsRequest - default GetWorkUnitsPublisher getWorkUnitsPaginator(Consumer<GetWorkUnitsRequest.Builder> getWorkUnitsRequest)
Retrieves the work units generated by the StartQueryPlanning operation.
This is a variant of
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsPublisher publisher = client.getWorkUnitsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.GetWorkUnitsPublisher publisher = client.getWorkUnitsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of PageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getWorkUnits(software.amazon.awssdk.services.lakeformation.model.GetWorkUnitsRequest) operation.
This is a convenience which creates an instance of the GetWorkUnitsRequest.Builder avoiding the need to
create one manually via GetWorkUnitsRequest.builder()
getWorkUnitsRequest - A Consumer that will call methods on GetWorkUnitsRequest.Builder to create a request.default CompletableFuture<GrantPermissionsResponse> grantPermissions(GrantPermissionsRequest grantPermissionsRequest)
Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
For information about permissions, see Security and Access Control to Metadata and Data.
grantPermissionsRequest - default CompletableFuture<GrantPermissionsResponse> grantPermissions(Consumer<GrantPermissionsRequest.Builder> grantPermissionsRequest)
Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a convenience which creates an instance of the GrantPermissionsRequest.Builder avoiding the need
to create one manually via GrantPermissionsRequest.builder()
grantPermissionsRequest - A Consumer that will call methods on GrantPermissionsRequest.Builder to create a request.default CompletableFuture<ListDataCellsFilterResponse> listDataCellsFilter(ListDataCellsFilterRequest listDataCellsFilterRequest)
Lists all the data cell filters on a table.
listDataCellsFilterRequest - default CompletableFuture<ListDataCellsFilterResponse> listDataCellsFilter(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest)
Lists all the data cell filters on a table.
This is a convenience which creates an instance of the ListDataCellsFilterRequest.Builder avoiding the
need to create one manually via ListDataCellsFilterRequest.builder()
listDataCellsFilterRequest - A Consumer that will call methods on ListDataCellsFilterRequest.Builder to create a
request.default ListDataCellsFilterPublisher listDataCellsFilterPaginator(ListDataCellsFilterRequest listDataCellsFilterRequest)
Lists all the data cell filters on a table.
This is a variant of
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterPublisher publisher = client.listDataCellsFilterPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterPublisher publisher = client.listDataCellsFilterPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)
operation.
listDataCellsFilterRequest - default ListDataCellsFilterPublisher listDataCellsFilterPaginator(Consumer<ListDataCellsFilterRequest.Builder> listDataCellsFilterRequest)
Lists all the data cell filters on a table.
This is a variant of
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterPublisher publisher = client.listDataCellsFilterPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListDataCellsFilterPublisher publisher = client.listDataCellsFilterPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataCellsFilter(software.amazon.awssdk.services.lakeformation.model.ListDataCellsFilterRequest)
operation.
This is a convenience which creates an instance of the ListDataCellsFilterRequest.Builder avoiding the
need to create one manually via ListDataCellsFilterRequest.builder()
listDataCellsFilterRequest - A Consumer that will call methods on ListDataCellsFilterRequest.Builder to create a
request.default CompletableFuture<ListLfTagsResponse> listLFTags(ListLfTagsRequest listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
listLfTagsRequest - default CompletableFuture<ListLfTagsResponse> listLFTags(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
This is a convenience which creates an instance of the ListLfTagsRequest.Builder avoiding the need to
create one manually via ListLfTagsRequest.builder()
listLfTagsRequest - A Consumer that will call methods on ListLFTagsRequest.Builder to create a request.default ListLFTagsPublisher listLFTagsPaginator(ListLfTagsRequest listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
This is a variant of listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsPublisher publisher = client.listLFTagsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsPublisher publisher = client.listLFTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest) operation.
listLfTagsRequest - default ListLFTagsPublisher listLFTagsPaginator(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest)
Lists LF-tags that the requester has permission to view.
This is a variant of listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsPublisher publisher = client.listLFTagsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListLFTagsPublisher publisher = client.listLFTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListLfTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLFTags(software.amazon.awssdk.services.lakeformation.model.ListLfTagsRequest) operation.
This is a convenience which creates an instance of the ListLfTagsRequest.Builder avoiding the need to
create one manually via ListLfTagsRequest.builder()
listLfTagsRequest - A Consumer that will call methods on ListLFTagsRequest.Builder to create a request.default CompletableFuture<ListPermissionsResponse> listPermissions(ListPermissionsRequest listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
listPermissionsRequest - default CompletableFuture<ListPermissionsResponse> listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a convenience which creates an instance of the ListPermissionsRequest.Builder avoiding the need
to create one manually via ListPermissionsRequest.builder()
listPermissionsRequest - A Consumer that will call methods on ListPermissionsRequest.Builder to create a request.default ListPermissionsPublisher listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a variant of
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)
operation.
listPermissionsRequest - default ListPermissionsPublisher listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a variant of
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)
operation.
This is a convenience which creates an instance of the ListPermissionsRequest.Builder avoiding the need
to create one manually via ListPermissionsRequest.builder()
listPermissionsRequest - A Consumer that will call methods on ListPermissionsRequest.Builder to create a request.default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
listResourcesRequest - default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.default ListResourcesPublisher listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
This is a variant of
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation.
listResourcesRequest - default ListResourcesPublisher listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
This is a variant of
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation.
This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.default CompletableFuture<ListTableStorageOptimizersResponse> listTableStorageOptimizers(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
listTableStorageOptimizersRequest - default CompletableFuture<ListTableStorageOptimizersResponse> listTableStorageOptimizers(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
This is a convenience which creates an instance of the ListTableStorageOptimizersRequest.Builder avoiding
the need to create one manually via ListTableStorageOptimizersRequest.builder()
listTableStorageOptimizersRequest - A Consumer that will call methods on ListTableStorageOptimizersRequest.Builder to create a
request.default ListTableStorageOptimizersPublisher listTableStorageOptimizersPaginator(ListTableStorageOptimizersRequest listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
This is a variant of
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersPublisher publisher = client.listTableStorageOptimizersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersPublisher publisher = client.listTableStorageOptimizersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)
operation.
listTableStorageOptimizersRequest - default ListTableStorageOptimizersPublisher listTableStorageOptimizersPaginator(Consumer<ListTableStorageOptimizersRequest.Builder> listTableStorageOptimizersRequest)
Returns the configuration of all storage optimizers associated with a specified table.
This is a variant of
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersPublisher publisher = client.listTableStorageOptimizersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListTableStorageOptimizersPublisher publisher = client.listTableStorageOptimizersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableStorageOptimizers(software.amazon.awssdk.services.lakeformation.model.ListTableStorageOptimizersRequest)
operation.
This is a convenience which creates an instance of the ListTableStorageOptimizersRequest.Builder avoiding
the need to create one manually via ListTableStorageOptimizersRequest.builder()
listTableStorageOptimizersRequest - A Consumer that will call methods on ListTableStorageOptimizersRequest.Builder to create a
request.default CompletableFuture<ListTransactionsResponse> listTransactions(ListTransactionsRequest listTransactionsRequest)
Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
This operation can help you identify uncommitted transactions or to get information about transactions.
listTransactionsRequest - default CompletableFuture<ListTransactionsResponse> listTransactions(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest)
Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
This operation can help you identify uncommitted transactions or to get information about transactions.
This is a convenience which creates an instance of the ListTransactionsRequest.Builder avoiding the need
to create one manually via ListTransactionsRequest.builder()
listTransactionsRequest - A Consumer that will call methods on ListTransactionsRequest.Builder to create a request.default ListTransactionsPublisher listTransactionsPaginator(ListTransactionsRequest listTransactionsRequest)
Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
This operation can help you identify uncommitted transactions or to get information about transactions.
This is a variant of
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsPublisher publisher = client.listTransactionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsPublisher publisher = client.listTransactionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)
operation.
listTransactionsRequest - default ListTransactionsPublisher listTransactionsPaginator(Consumer<ListTransactionsRequest.Builder> listTransactionsRequest)
Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
This operation can help you identify uncommitted transactions or to get information about transactions.
This is a variant of
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsPublisher publisher = client.listTransactionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.ListTransactionsPublisher publisher = client.listTransactionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.ListTransactionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTransactions(software.amazon.awssdk.services.lakeformation.model.ListTransactionsRequest)
operation.
This is a convenience which creates an instance of the ListTransactionsRequest.Builder avoiding the need
to create one manually via ListTransactionsRequest.builder()
listTransactionsRequest - A Consumer that will call methods on ListTransactionsRequest.Builder to create a request.default CompletableFuture<PutDataLakeSettingsResponse> putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
putDataLakeSettingsRequest - default CompletableFuture<PutDataLakeSettingsResponse> putDataLakeSettings(Consumer<PutDataLakeSettingsRequest.Builder> putDataLakeSettingsRequest)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
This is a convenience which creates an instance of the PutDataLakeSettingsRequest.Builder avoiding the
need to create one manually via PutDataLakeSettingsRequest.builder()
putDataLakeSettingsRequest - A Consumer that will call methods on PutDataLakeSettingsRequest.Builder to create a
request.default CompletableFuture<RegisterResourceResponse> registerResource(RegisterResourceRequest registerResourceRequest)
Registers the resource as managed by the Data Catalog.
To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true
If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:
arn:aws:iam::12345:role/my-data-access-role
registerResourceRequest - default CompletableFuture<RegisterResourceResponse> registerResource(Consumer<RegisterResourceRequest.Builder> registerResourceRequest)
Registers the resource as managed by the Data Catalog.
To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true
If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:
arn:aws:iam::12345:role/my-data-access-role
This is a convenience which creates an instance of the RegisterResourceRequest.Builder avoiding the need
to create one manually via RegisterResourceRequest.builder()
registerResourceRequest - A Consumer that will call methods on RegisterResourceRequest.Builder to create a request.default CompletableFuture<RemoveLfTagsFromResourceResponse> removeLFTagsFromResource(RemoveLfTagsFromResourceRequest removeLfTagsFromResourceRequest)
Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag
columns, use the column inclusion list in tableWithColumns to specify column input.
removeLfTagsFromResourceRequest - default CompletableFuture<RemoveLfTagsFromResourceResponse> removeLFTagsFromResource(Consumer<RemoveLfTagsFromResourceRequest.Builder> removeLfTagsFromResourceRequest)
Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag
columns, use the column inclusion list in tableWithColumns to specify column input.
This is a convenience which creates an instance of the RemoveLfTagsFromResourceRequest.Builder avoiding
the need to create one manually via RemoveLfTagsFromResourceRequest.builder()
removeLfTagsFromResourceRequest - A Consumer that will call methods on RemoveLFTagsFromResourceRequest.Builder to create a
request.default CompletableFuture<RevokePermissionsResponse> revokePermissions(RevokePermissionsRequest revokePermissionsRequest)
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
revokePermissionsRequest - default CompletableFuture<RevokePermissionsResponse> revokePermissions(Consumer<RevokePermissionsRequest.Builder> revokePermissionsRequest)
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
This is a convenience which creates an instance of the RevokePermissionsRequest.Builder avoiding the need
to create one manually via RevokePermissionsRequest.builder()
revokePermissionsRequest - A Consumer that will call methods on RevokePermissionsRequest.Builder to create a request.default CompletableFuture<SearchDatabasesByLfTagsResponse> searchDatabasesByLFTags(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest)
This operation allows a search on DATABASE resources by TagCondition. This operation is
used by admins who want to grant user permissions on certain TagConditions. Before making a grant,
the admin can use SearchDatabasesByTags to find all resources where the given
TagConditions are valid to verify whether the returned resources can be shared.
searchDatabasesByLfTagsRequest - default CompletableFuture<SearchDatabasesByLfTagsResponse> searchDatabasesByLFTags(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest)
This operation allows a search on DATABASE resources by TagCondition. This operation is
used by admins who want to grant user permissions on certain TagConditions. Before making a grant,
the admin can use SearchDatabasesByTags to find all resources where the given
TagConditions are valid to verify whether the returned resources can be shared.
This is a convenience which creates an instance of the SearchDatabasesByLfTagsRequest.Builder avoiding
the need to create one manually via SearchDatabasesByLfTagsRequest.builder()
searchDatabasesByLfTagsRequest - A Consumer that will call methods on SearchDatabasesByLFTagsRequest.Builder to create a
request.default SearchDatabasesByLFTagsPublisher searchDatabasesByLFTagsPaginator(SearchDatabasesByLfTagsRequest searchDatabasesByLfTagsRequest)
This operation allows a search on DATABASE resources by TagCondition. This operation is
used by admins who want to grant user permissions on certain TagConditions. Before making a grant,
the admin can use SearchDatabasesByTags to find all resources where the given
TagConditions are valid to verify whether the returned resources can be shared.
This is a variant of
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsPublisher publisher = client.searchDatabasesByLFTagsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsPublisher publisher = client.searchDatabasesByLFTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)
operation.
searchDatabasesByLfTagsRequest - default SearchDatabasesByLFTagsPublisher searchDatabasesByLFTagsPaginator(Consumer<SearchDatabasesByLfTagsRequest.Builder> searchDatabasesByLfTagsRequest)
This operation allows a search on DATABASE resources by TagCondition. This operation is
used by admins who want to grant user permissions on certain TagConditions. Before making a grant,
the admin can use SearchDatabasesByTags to find all resources where the given
TagConditions are valid to verify whether the returned resources can be shared.
This is a variant of
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsPublisher publisher = client.searchDatabasesByLFTagsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.SearchDatabasesByLFTagsPublisher publisher = client.searchDatabasesByLFTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDatabasesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchDatabasesByLfTagsRequest)
operation.
This is a convenience which creates an instance of the SearchDatabasesByLfTagsRequest.Builder avoiding
the need to create one manually via SearchDatabasesByLfTagsRequest.builder()
searchDatabasesByLfTagsRequest - A Consumer that will call methods on SearchDatabasesByLFTagsRequest.Builder to create a
request.default CompletableFuture<SearchTablesByLfTagsResponse> searchTablesByLFTags(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest)
This operation allows a search on TABLE resources by LFTags. This will be used by
admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use
SearchTablesByLFTags to find all resources where the given LFTags are valid to verify
whether the returned resources can be shared.
searchTablesByLfTagsRequest - default CompletableFuture<SearchTablesByLfTagsResponse> searchTablesByLFTags(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest)
This operation allows a search on TABLE resources by LFTags. This will be used by
admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use
SearchTablesByLFTags to find all resources where the given LFTags are valid to verify
whether the returned resources can be shared.
This is a convenience which creates an instance of the SearchTablesByLfTagsRequest.Builder avoiding the
need to create one manually via SearchTablesByLfTagsRequest.builder()
searchTablesByLfTagsRequest - A Consumer that will call methods on SearchTablesByLFTagsRequest.Builder to create a
request.default SearchTablesByLFTagsPublisher searchTablesByLFTagsPaginator(SearchTablesByLfTagsRequest searchTablesByLfTagsRequest)
This operation allows a search on TABLE resources by LFTags. This will be used by
admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use
SearchTablesByLFTags to find all resources where the given LFTags are valid to verify
whether the returned resources can be shared.
This is a variant of
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsPublisher publisher = client.searchTablesByLFTagsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsPublisher publisher = client.searchTablesByLFTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)
operation.
searchTablesByLfTagsRequest - default SearchTablesByLFTagsPublisher searchTablesByLFTagsPaginator(Consumer<SearchTablesByLfTagsRequest.Builder> searchTablesByLfTagsRequest)
This operation allows a search on TABLE resources by LFTags. This will be used by
admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use
SearchTablesByLFTags to find all resources where the given LFTags are valid to verify
whether the returned resources can be shared.
This is a variant of
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsPublisher publisher = client.searchTablesByLFTagsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lakeformation.paginators.SearchTablesByLFTagsPublisher publisher = client.searchTablesByLFTagsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchTablesByLFTags(software.amazon.awssdk.services.lakeformation.model.SearchTablesByLfTagsRequest)
operation.
This is a convenience which creates an instance of the SearchTablesByLfTagsRequest.Builder avoiding the
need to create one manually via SearchTablesByLfTagsRequest.builder()
searchTablesByLfTagsRequest - A Consumer that will call methods on SearchTablesByLFTagsRequest.Builder to create a
request.default CompletableFuture<StartQueryPlanningResponse> startQueryPlanning(StartQueryPlanningRequest startQueryPlanningRequest)
Submits a request to process a query statement.
This operation generates work units that can be retrieved with the GetWorkUnits operation as soon as
the query state is WORKUNITS_AVAILABLE or FINISHED.
startQueryPlanningRequest - default CompletableFuture<StartQueryPlanningResponse> startQueryPlanning(Consumer<StartQueryPlanningRequest.Builder> startQueryPlanningRequest)
Submits a request to process a query statement.
This operation generates work units that can be retrieved with the GetWorkUnits operation as soon as
the query state is WORKUNITS_AVAILABLE or FINISHED.
This is a convenience which creates an instance of the StartQueryPlanningRequest.Builder avoiding the
need to create one manually via StartQueryPlanningRequest.builder()
startQueryPlanningRequest - A Consumer that will call methods on StartQueryPlanningRequest.Builder to create a
request.default CompletableFuture<StartTransactionResponse> startTransaction(StartTransactionRequest startTransactionRequest)
Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
startTransactionRequest - default CompletableFuture<StartTransactionResponse> startTransaction(Consumer<StartTransactionRequest.Builder> startTransactionRequest)
Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
This is a convenience which creates an instance of the StartTransactionRequest.Builder avoiding the need
to create one manually via StartTransactionRequest.builder()
startTransactionRequest - A Consumer that will call methods on StartTransactionRequest.Builder to create a request.default CompletableFuture<UpdateLfTagResponse> updateLFTag(UpdateLfTagRequest updateLfTagRequest)
Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.
updateLfTagRequest - default CompletableFuture<UpdateLfTagResponse> updateLFTag(Consumer<UpdateLfTagRequest.Builder> updateLfTagRequest)
Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value.
This is a convenience which creates an instance of the UpdateLfTagRequest.Builder avoiding the need to
create one manually via UpdateLfTagRequest.builder()
updateLfTagRequest - A Consumer that will call methods on UpdateLFTagRequest.Builder to create a request.default CompletableFuture<UpdateResourceResponse> updateResource(UpdateResourceRequest updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
updateResourceRequest - default CompletableFuture<UpdateResourceResponse> updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
This is a convenience which creates an instance of the UpdateResourceRequest.Builder avoiding the need to
create one manually via UpdateResourceRequest.builder()
updateResourceRequest - A Consumer that will call methods on UpdateResourceRequest.Builder to create a request.default CompletableFuture<UpdateTableObjectsResponse> updateTableObjects(UpdateTableObjectsRequest updateTableObjectsRequest)
Updates the manifest of Amazon S3 objects that make up the specified governed table.
updateTableObjectsRequest - UpdateTableObjects.default CompletableFuture<UpdateTableObjectsResponse> updateTableObjects(Consumer<UpdateTableObjectsRequest.Builder> updateTableObjectsRequest)
Updates the manifest of Amazon S3 objects that make up the specified governed table.
This is a convenience which creates an instance of the UpdateTableObjectsRequest.Builder avoiding the
need to create one manually via UpdateTableObjectsRequest.builder()
updateTableObjectsRequest - A Consumer that will call methods on UpdateTableObjectsRequest.Builder to create a
request.UpdateTableObjects.default CompletableFuture<UpdateTableStorageOptimizerResponse> updateTableStorageOptimizer(UpdateTableStorageOptimizerRequest updateTableStorageOptimizerRequest)
Updates the configuration of the storage optimizers for a table.
updateTableStorageOptimizerRequest - default CompletableFuture<UpdateTableStorageOptimizerResponse> updateTableStorageOptimizer(Consumer<UpdateTableStorageOptimizerRequest.Builder> updateTableStorageOptimizerRequest)
Updates the configuration of the storage optimizers for a table.
This is a convenience which creates an instance of the UpdateTableStorageOptimizerRequest.Builder
avoiding the need to create one manually via UpdateTableStorageOptimizerRequest.builder()
updateTableStorageOptimizerRequest - A Consumer that will call methods on UpdateTableStorageOptimizerRequest.Builder to create
a request.static LakeFormationAsyncClient create()
LakeFormationAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static LakeFormationAsyncClientBuilder builder()
LakeFormationAsyncClient.Copyright © 2023. All rights reserved.