@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSLakeFormationAsync extends AbstractAWSLakeFormation implements AWSLakeFormationAsync
AWSLakeFormationAsync. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAWSLakeFormationAsync() |
addLFTagsToResource, batchGrantPermissions, batchRevokePermissions, createLFTag, deleteLFTag, deregisterResource, describeResource, getCachedResponseMetadata, getDataLakeSettings, getEffectivePermissionsForPath, getLFTag, getResourceLFTags, grantPermissions, listLFTags, listPermissions, listResources, putDataLakeSettings, registerResource, removeLFTagsFromResource, revokePermissions, searchDatabasesByLFTags, searchTablesByLFTags, shutdown, updateLFTag, updateResourceclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddLFTagsToResource, batchGrantPermissions, batchRevokePermissions, createLFTag, deleteLFTag, deregisterResource, describeResource, getCachedResponseMetadata, getDataLakeSettings, getEffectivePermissionsForPath, getLFTag, getResourceLFTags, grantPermissions, listLFTags, listPermissions, listResources, putDataLakeSettings, registerResource, removeLFTagsFromResource, revokePermissions, searchDatabasesByLFTags, searchTablesByLFTags, shutdown, updateLFTag, updateResourcepublic Future<AddLFTagsToResourceResult> addLFTagsToResourceAsync(AddLFTagsToResourceRequest request)
AWSLakeFormationAsyncAttaches one or more tags to an existing resource.
addLFTagsToResourceAsync in interface AWSLakeFormationAsyncpublic Future<AddLFTagsToResourceResult> addLFTagsToResourceAsync(AddLFTagsToResourceRequest request, AsyncHandler<AddLFTagsToResourceRequest,AddLFTagsToResourceResult> asyncHandler)
AWSLakeFormationAsyncAttaches one or more tags to an existing resource.
addLFTagsToResourceAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchGrantPermissionsResult> batchGrantPermissionsAsync(BatchGrantPermissionsRequest request)
AWSLakeFormationAsyncBatch operation to grant permissions to the principal.
batchGrantPermissionsAsync in interface AWSLakeFormationAsyncpublic Future<BatchGrantPermissionsResult> batchGrantPermissionsAsync(BatchGrantPermissionsRequest request, AsyncHandler<BatchGrantPermissionsRequest,BatchGrantPermissionsResult> asyncHandler)
AWSLakeFormationAsyncBatch operation to grant permissions to the principal.
batchGrantPermissionsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BatchRevokePermissionsResult> batchRevokePermissionsAsync(BatchRevokePermissionsRequest request)
AWSLakeFormationAsyncBatch operation to revoke permissions from the principal.
batchRevokePermissionsAsync in interface AWSLakeFormationAsyncpublic Future<BatchRevokePermissionsResult> batchRevokePermissionsAsync(BatchRevokePermissionsRequest request, AsyncHandler<BatchRevokePermissionsRequest,BatchRevokePermissionsResult> asyncHandler)
AWSLakeFormationAsyncBatch operation to revoke permissions from the principal.
batchRevokePermissionsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLFTagResult> createLFTagAsync(CreateLFTagRequest request)
AWSLakeFormationAsyncCreates a tag with the specified name and values.
createLFTagAsync in interface AWSLakeFormationAsyncpublic Future<CreateLFTagResult> createLFTagAsync(CreateLFTagRequest request, AsyncHandler<CreateLFTagRequest,CreateLFTagResult> asyncHandler)
AWSLakeFormationAsyncCreates a tag with the specified name and values.
createLFTagAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLFTagResult> deleteLFTagAsync(DeleteLFTagRequest request)
AWSLakeFormationAsyncDeletes the specified tag key name. If the attribute key does not exist or the tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message "Delete not allowed" as the tag key is still attached with resources. You can consider untagging resources with this tag key.
deleteLFTagAsync in interface AWSLakeFormationAsyncpublic Future<DeleteLFTagResult> deleteLFTagAsync(DeleteLFTagRequest request, AsyncHandler<DeleteLFTagRequest,DeleteLFTagResult> asyncHandler)
AWSLakeFormationAsyncDeletes the specified tag key name. If the attribute key does not exist or the tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message "Delete not allowed" as the tag key is still attached with resources. You can consider untagging resources with this tag key.
deleteLFTagAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeregisterResourceResult> deregisterResourceAsync(DeregisterResourceRequest request)
AWSLakeFormationAsyncDeregisters 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.
deregisterResourceAsync in interface AWSLakeFormationAsyncpublic Future<DeregisterResourceResult> deregisterResourceAsync(DeregisterResourceRequest request, AsyncHandler<DeregisterResourceRequest,DeregisterResourceResult> asyncHandler)
AWSLakeFormationAsyncDeregisters 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.
deregisterResourceAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeResourceResult> describeResourceAsync(DescribeResourceRequest request)
AWSLakeFormationAsyncRetrieves the current data access role for the given resource registered in AWS Lake Formation.
describeResourceAsync in interface AWSLakeFormationAsyncpublic Future<DescribeResourceResult> describeResourceAsync(DescribeResourceRequest request, AsyncHandler<DescribeResourceRequest,DescribeResourceResult> asyncHandler)
AWSLakeFormationAsyncRetrieves the current data access role for the given resource registered in AWS Lake Formation.
describeResourceAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDataLakeSettingsResult> getDataLakeSettingsAsync(GetDataLakeSettingsRequest request)
AWSLakeFormationAsyncRetrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getDataLakeSettingsAsync in interface AWSLakeFormationAsyncpublic Future<GetDataLakeSettingsResult> getDataLakeSettingsAsync(GetDataLakeSettingsRequest request, AsyncHandler<GetDataLakeSettingsRequest,GetDataLakeSettingsResult> asyncHandler)
AWSLakeFormationAsyncRetrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getDataLakeSettingsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetEffectivePermissionsForPathResult> getEffectivePermissionsForPathAsync(GetEffectivePermissionsForPathRequest request)
AWSLakeFormationAsync
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.
getEffectivePermissionsForPathAsync in interface AWSLakeFormationAsyncpublic Future<GetEffectivePermissionsForPathResult> getEffectivePermissionsForPathAsync(GetEffectivePermissionsForPathRequest request, AsyncHandler<GetEffectivePermissionsForPathRequest,GetEffectivePermissionsForPathResult> asyncHandler)
AWSLakeFormationAsync
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.
getEffectivePermissionsForPathAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetLFTagResult> getLFTagAsync(GetLFTagRequest request)
AWSLakeFormationAsyncReturns a tag definition.
getLFTagAsync in interface AWSLakeFormationAsyncpublic Future<GetLFTagResult> getLFTagAsync(GetLFTagRequest request, AsyncHandler<GetLFTagRequest,GetLFTagResult> asyncHandler)
AWSLakeFormationAsyncReturns a tag definition.
getLFTagAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetResourceLFTagsResult> getResourceLFTagsAsync(GetResourceLFTagsRequest request)
AWSLakeFormationAsyncReturns the tags applied to a resource.
getResourceLFTagsAsync in interface AWSLakeFormationAsyncpublic Future<GetResourceLFTagsResult> getResourceLFTagsAsync(GetResourceLFTagsRequest request, AsyncHandler<GetResourceLFTagsRequest,GetResourceLFTagsResult> asyncHandler)
AWSLakeFormationAsyncReturns the tags applied to a resource.
getResourceLFTagsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GrantPermissionsResult> grantPermissionsAsync(GrantPermissionsRequest request)
AWSLakeFormationAsyncGrants 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.
grantPermissionsAsync in interface AWSLakeFormationAsyncpublic Future<GrantPermissionsResult> grantPermissionsAsync(GrantPermissionsRequest request, AsyncHandler<GrantPermissionsRequest,GrantPermissionsResult> asyncHandler)
AWSLakeFormationAsyncGrants 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.
grantPermissionsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLFTagsResult> listLFTagsAsync(ListLFTagsRequest request)
AWSLakeFormationAsyncLists tags that the requester has permission to view.
listLFTagsAsync in interface AWSLakeFormationAsyncpublic Future<ListLFTagsResult> listLFTagsAsync(ListLFTagsRequest request, AsyncHandler<ListLFTagsRequest,ListLFTagsResult> asyncHandler)
AWSLakeFormationAsyncLists tags that the requester has permission to view.
listLFTagsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPermissionsResult> listPermissionsAsync(ListPermissionsRequest request)
AWSLakeFormationAsyncReturns 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.
listPermissionsAsync in interface AWSLakeFormationAsyncpublic Future<ListPermissionsResult> listPermissionsAsync(ListPermissionsRequest request, AsyncHandler<ListPermissionsRequest,ListPermissionsResult> asyncHandler)
AWSLakeFormationAsyncReturns 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.
listPermissionsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest request)
AWSLakeFormationAsyncLists the resources registered to be managed by the Data Catalog.
listResourcesAsync in interface AWSLakeFormationAsyncpublic Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest request, AsyncHandler<ListResourcesRequest,ListResourcesResult> asyncHandler)
AWSLakeFormationAsyncLists the resources registered to be managed by the Data Catalog.
listResourcesAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutDataLakeSettingsResult> putDataLakeSettingsAsync(PutDataLakeSettingsRequest request)
AWSLakeFormationAsyncSets 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.
putDataLakeSettingsAsync in interface AWSLakeFormationAsyncpublic Future<PutDataLakeSettingsResult> putDataLakeSettingsAsync(PutDataLakeSettingsRequest request, AsyncHandler<PutDataLakeSettingsRequest,PutDataLakeSettingsResult> asyncHandler)
AWSLakeFormationAsyncSets 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.
putDataLakeSettingsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RegisterResourceResult> registerResourceAsync(RegisterResourceRequest request)
AWSLakeFormationAsyncRegisters 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 AWS 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
registerResourceAsync in interface AWSLakeFormationAsyncpublic Future<RegisterResourceResult> registerResourceAsync(RegisterResourceRequest request, AsyncHandler<RegisterResourceRequest,RegisterResourceResult> asyncHandler)
AWSLakeFormationAsyncRegisters 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 AWS 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
registerResourceAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemoveLFTagsFromResourceResult> removeLFTagsFromResourceAsync(RemoveLFTagsFromResourceRequest request)
AWSLakeFormationAsync
Removes a 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.
removeLFTagsFromResourceAsync in interface AWSLakeFormationAsyncpublic Future<RemoveLFTagsFromResourceResult> removeLFTagsFromResourceAsync(RemoveLFTagsFromResourceRequest request, AsyncHandler<RemoveLFTagsFromResourceRequest,RemoveLFTagsFromResourceResult> asyncHandler)
AWSLakeFormationAsync
Removes a 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.
removeLFTagsFromResourceAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RevokePermissionsResult> revokePermissionsAsync(RevokePermissionsRequest request)
AWSLakeFormationAsyncRevokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
revokePermissionsAsync in interface AWSLakeFormationAsyncpublic Future<RevokePermissionsResult> revokePermissionsAsync(RevokePermissionsRequest request, AsyncHandler<RevokePermissionsRequest,RevokePermissionsResult> asyncHandler)
AWSLakeFormationAsyncRevokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
revokePermissionsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchDatabasesByLFTagsResult> searchDatabasesByLFTagsAsync(SearchDatabasesByLFTagsRequest request)
AWSLakeFormationAsync
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.
searchDatabasesByLFTagsAsync in interface AWSLakeFormationAsyncpublic Future<SearchDatabasesByLFTagsResult> searchDatabasesByLFTagsAsync(SearchDatabasesByLFTagsRequest request, AsyncHandler<SearchDatabasesByLFTagsRequest,SearchDatabasesByLFTagsResult> asyncHandler)
AWSLakeFormationAsync
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.
searchDatabasesByLFTagsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SearchTablesByLFTagsResult> searchTablesByLFTagsAsync(SearchTablesByLFTagsRequest request)
AWSLakeFormationAsync
This operation allows a search on TABLE resources by LFTags. This will be used by
admins who want to grant user permissions on certain LFTags. 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.
searchTablesByLFTagsAsync in interface AWSLakeFormationAsyncpublic Future<SearchTablesByLFTagsResult> searchTablesByLFTagsAsync(SearchTablesByLFTagsRequest request, AsyncHandler<SearchTablesByLFTagsRequest,SearchTablesByLFTagsResult> asyncHandler)
AWSLakeFormationAsync
This operation allows a search on TABLE resources by LFTags. This will be used by
admins who want to grant user permissions on certain LFTags. 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.
searchTablesByLFTagsAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLFTagResult> updateLFTagAsync(UpdateLFTagRequest request)
AWSLakeFormationAsyncUpdates the list of possible values for the specified tag key. If the 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 tag key's value.
updateLFTagAsync in interface AWSLakeFormationAsyncpublic Future<UpdateLFTagResult> updateLFTagAsync(UpdateLFTagRequest request, AsyncHandler<UpdateLFTagRequest,UpdateLFTagResult> asyncHandler)
AWSLakeFormationAsyncUpdates the list of possible values for the specified tag key. If the 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 tag key's value.
updateLFTagAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest request)
AWSLakeFormationAsyncUpdates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
updateResourceAsync in interface AWSLakeFormationAsyncpublic Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest request, AsyncHandler<UpdateResourceRequest,UpdateResourceResult> asyncHandler)
AWSLakeFormationAsyncUpdates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
updateResourceAsync in interface AWSLakeFormationAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2021. All rights reserved.