@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface LakeFormationAsyncClient extends SdkClient
builder() method.
Defines the public endpoint for the AWS 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 tags to an existing resource.
|
default CompletableFuture<AddLfTagsToResourceResponse> |
addLFTagsToResource(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest)
Attaches one or more tags to an existing resource.
|
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. |
static LakeFormationAsyncClient |
create()
Create a
LakeFormationAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateLfTagResponse> |
createLFTag(Consumer<CreateLfTagRequest.Builder> createLfTagRequest)
Creates a tag with the specified name and values.
|
default CompletableFuture<CreateLfTagResponse> |
createLFTag(CreateLfTagRequest createLfTagRequest)
Creates a tag with the specified name and values.
|
default CompletableFuture<DeleteLfTagResponse> |
deleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest)
Deletes the specified tag key name.
|
default CompletableFuture<DeleteLfTagResponse> |
deleteLFTag(DeleteLfTagRequest deleteLfTagRequest)
Deletes the specified tag key name.
|
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 AWS Lake Formation.
|
default CompletableFuture<DescribeResourceResponse> |
describeResource(DescribeResourceRequest describeResourceRequest)
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
|
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 a tag definition.
|
default CompletableFuture<GetLfTagResponse> |
getLFTag(GetLfTagRequest getLfTagRequest)
Returns a tag definition.
|
default CompletableFuture<GetResourceLfTagsResponse> |
getResourceLFTags(Consumer<GetResourceLfTagsRequest.Builder> getResourceLfTagsRequest)
Returns the tags applied to a resource.
|
default CompletableFuture<GetResourceLfTagsResponse> |
getResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest)
Returns the tags applied to a resource.
|
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<ListLfTagsResponse> |
listLFTags(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest)
Lists tags that the requester has permission to view.
|
default CompletableFuture<ListLfTagsResponse> |
listLFTags(ListLfTagsRequest listLfTagsRequest)
Lists 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<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 a tag from the resource.
|
default CompletableFuture<RemoveLfTagsFromResourceResponse> |
removeLFTagsFromResource(RemoveLfTagsFromResourceRequest removeLfTagsFromResourceRequest)
Removes a 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 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 CompletableFuture<UpdateLfTagResponse> |
updateLFTag(Consumer<UpdateLfTagRequest.Builder> updateLfTagRequest)
Updates the list of possible values for the specified tag key.
|
default CompletableFuture<UpdateLfTagResponse> |
updateLFTag(UpdateLfTagRequest updateLfTagRequest)
Updates the list of possible values for the specified 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 AWS Lake Formation.
|
default CompletableFuture<UpdateResourceResponse> |
updateResource(UpdateResourceRequest updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static LakeFormationAsyncClient create()
LakeFormationAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static LakeFormationAsyncClientBuilder builder()
LakeFormationAsyncClient.default CompletableFuture<AddLfTagsToResourceResponse> addLFTagsToResource(AddLfTagsToResourceRequest addLfTagsToResourceRequest)
Attaches one or more tags to an existing resource.
addLfTagsToResourceRequest - default CompletableFuture<AddLfTagsToResourceResponse> addLFTagsToResource(Consumer<AddLfTagsToResourceRequest.Builder> addLfTagsToResourceRequest)
Attaches one or more 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<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<CreateLfTagResponse> createLFTag(CreateLfTagRequest createLfTagRequest)
Creates a tag with the specified name and values.
createLfTagRequest - default CompletableFuture<CreateLfTagResponse> createLFTag(Consumer<CreateLfTagRequest.Builder> createLfTagRequest)
Creates a 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<DeleteLfTagResponse> deleteLFTag(DeleteLfTagRequest deleteLfTagRequest)
Deletes 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.
deleteLfTagRequest - default CompletableFuture<DeleteLfTagResponse> deleteLFTag(Consumer<DeleteLfTagRequest.Builder> deleteLfTagRequest)
Deletes 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.
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<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 AWS Lake Formation.
describeResourceRequest - default CompletableFuture<DescribeResourceResponse> describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)
Retrieves the current data access role for the given resource registered in AWS 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<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 a tag definition.
getLfTagRequest - default CompletableFuture<GetLfTagResponse> getLFTag(Consumer<GetLfTagRequest.Builder> getLfTagRequest)
Returns a 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<GetResourceLfTagsResponse> getResourceLFTags(GetResourceLfTagsRequest getResourceLfTagsRequest)
Returns the tags applied to a resource.
getResourceLfTagsRequest - default CompletableFuture<GetResourceLfTagsResponse> getResourceLFTags(Consumer<GetResourceLfTagsRequest.Builder> getResourceLfTagsRequest)
Returns the 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<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<ListLfTagsResponse> listLFTags(ListLfTagsRequest listLfTagsRequest)
Lists tags that the requester has permission to view.
listLfTagsRequest - default CompletableFuture<ListLfTagsResponse> listLFTags(Consumer<ListLfTagsRequest.Builder> listLfTagsRequest)
Lists 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 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<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 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
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 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
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 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.
removeLfTagsFromResourceRequest - default CompletableFuture<RemoveLfTagsFromResourceResponse> removeLFTagsFromResource(Consumer<RemoveLfTagsFromResourceRequest.Builder> removeLfTagsFromResourceRequest)
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.
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 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 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.
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 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.
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<UpdateLfTagResponse> updateLFTag(UpdateLfTagRequest updateLfTagRequest)
Updates 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.
updateLfTagRequest - default CompletableFuture<UpdateLfTagResponse> updateLFTag(Consumer<UpdateLfTagRequest.Builder> updateLfTagRequest)
Updates 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.
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 AWS 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 AWS 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.Copyright © 2021. All rights reserved.