@Generated(value="software.amazon.awssdk:codegen") public interface LakeFormationClient extends SdkClient
builder() method.
Defines the public endpoint for the AWS Lake Formation service.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default BatchGrantPermissionsResponse |
batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
|
default BatchGrantPermissionsResponse |
batchGrantPermissions(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
|
default BatchRevokePermissionsResponse |
batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
|
default BatchRevokePermissionsResponse |
batchRevokePermissions(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
|
static LakeFormationClientBuilder |
builder()
Create a builder that can be used to configure and create a
LakeFormationClient. |
static LakeFormationClient |
create()
Create a
LakeFormationClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default DeregisterResourceResponse |
deregisterResource(Consumer<DeregisterResourceRequest.Builder> deregisterResourceRequest)
Deregisters the resource as managed by the Data Catalog.
|
default DeregisterResourceResponse |
deregisterResource(DeregisterResourceRequest deregisterResourceRequest)
Deregisters the resource as managed by the Data Catalog.
|
default DescribeResourceResponse |
describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest)
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
|
default DescribeResourceResponse |
describeResource(DescribeResourceRequest describeResourceRequest)
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
|
default GetDataLakeSettingsResponse |
getDataLakeSettings(Consumer<GetDataLakeSettingsRequest.Builder> getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
|
default GetDataLakeSettingsResponse |
getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
|
default 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 GetEffectivePermissionsForPathResponse |
getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
default GetEffectivePermissionsForPathIterable |
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 GetEffectivePermissionsForPathIterable |
getEffectivePermissionsForPathPaginator(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
default 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 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 ListPermissionsResponse |
listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default ListPermissionsResponse |
listPermissions(ListPermissionsRequest listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default ListPermissionsIterable |
listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default ListPermissionsIterable |
listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
default ListResourcesResponse |
listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default ListResourcesResponse |
listResources(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default ListResourcesIterable |
listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default ListResourcesIterable |
listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
default 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 PutDataLakeSettingsResponse |
putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
|
default RegisterResourceResponse |
registerResource(Consumer<RegisterResourceRequest.Builder> registerResourceRequest)
Registers the resource as managed by the Data Catalog.
|
default RegisterResourceResponse |
registerResource(RegisterResourceRequest registerResourceRequest)
Registers the resource as managed by the Data Catalog.
|
default 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 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.
|
static ServiceMetadata |
serviceMetadata() |
default 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 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 LakeFormationClient create()
LakeFormationClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static LakeFormationClientBuilder builder()
LakeFormationClient.default BatchGrantPermissionsResponse batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Batch operation to grant permissions to the principal.
batchGrantPermissionsRequest - InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGrantPermissionsResponse batchGrantPermissions(Consumer<BatchGrantPermissionsRequest.Builder> batchGrantPermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Batch operation to grant permissions to the principal.
This is a convenience which creates an instance of the BatchGrantPermissionsRequest.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.InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchRevokePermissionsResponse batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Batch operation to revoke permissions from the principal.
batchRevokePermissionsRequest - InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchRevokePermissionsResponse batchRevokePermissions(Consumer<BatchRevokePermissionsRequest.Builder> batchRevokePermissionsRequest) throws InvalidInputException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Batch operation to revoke permissions from the principal.
This is a convenience which creates an instance of the BatchRevokePermissionsRequest.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.InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterResourceResponse deregisterResource(DeregisterResourceRequest deregisterResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Deregisters the resource as managed by the Data Catalog.
When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
deregisterResourceRequest - InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterResourceResponse deregisterResource(Consumer<DeregisterResourceRequest.Builder> deregisterResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Deregisters the resource as managed by the Data Catalog.
When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
This is a convenience which creates an instance of the DeregisterResourceRequest.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.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeResourceResponse describeResource(DescribeResourceRequest describeResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
describeResourceRequest - InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeResourceResponse describeResource(Consumer<DescribeResourceRequest.Builder> describeResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Retrieves the current data access role for the given resource registered in 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.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDataLakeSettingsResponse getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getDataLakeSettingsRequest - InternalServiceException - An internal service error occurred.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDataLakeSettingsResponse getDataLakeSettings(Consumer<GetDataLakeSettingsRequest.Builder> getDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
This is a convenience which creates an instance of the GetDataLakeSettingsRequest.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.InternalServiceException - An internal service error occurred.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEffectivePermissionsForPathResponse getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.
getEffectivePermissionsForPathRequest - InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existOperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEffectivePermissionsForPathResponse getEffectivePermissionsForPath(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
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.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existOperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEffectivePermissionsForPathIterable getEffectivePermissionsForPathPaginator(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client
.getEffectivePermissionsForPathPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation.
getEffectivePermissionsForPathRequest - InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existOperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetEffectivePermissionsForPathIterable getEffectivePermissionsForPathPaginator(Consumer<GetEffectivePermissionsForPathRequest.Builder> getEffectivePermissionsForPathRequest) throws InvalidInputException, EntityNotFoundException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client
.getEffectivePermissionsForPathPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.GetEffectivePermissionsForPathIterable responses = client.getEffectivePermissionsForPathPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getEffectivePermissionsForPath(software.amazon.awssdk.services.lakeformation.model.GetEffectivePermissionsForPathRequest)
operation.
This is a convenience which creates an instance of the GetEffectivePermissionsForPathRequest.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.InvalidInputException - The input provided was not valid.EntityNotFoundException - A specified entity does not existOperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GrantPermissionsResponse grantPermissions(GrantPermissionsRequest grantPermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
For information about permissions, see Security and Access Control to Metadata and Data.
grantPermissionsRequest - ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GrantPermissionsResponse grantPermissions(Consumer<GrantPermissionsRequest.Builder> grantPermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a convenience which creates an instance of the GrantPermissionsRequest.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.ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPermissionsResponse listPermissions(ListPermissionsRequest listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
listPermissionsRequest - InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPermissionsResponse listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a convenience which creates an instance of the ListPermissionsRequest.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.InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPermissionsIterable listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a variant of
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client
.listPermissionsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)
operation.
listPermissionsRequest - InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPermissionsIterable listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidInputException, OperationTimeoutException, InternalServiceException, AwsServiceException, SdkClientException, LakeFormationException
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
This operation returns only those permissions that have been explicitly granted.
For information about permissions, see Security and Access Control to Metadata and Data.
This is a variant of
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client
.listPermissionsPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListPermissionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.lakeformation.model.ListPermissionsRequest)
operation.
This is a convenience which creates an instance of the ListPermissionsRequest.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.InvalidInputException - The input provided was not valid.OperationTimeoutException - The operation timed out.InternalServiceException - An internal service error occurred.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Lists the resources registered to be managed by the Data Catalog.
listResourcesRequest - InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Lists the resources registered to be managed by the Data Catalog.
This is a convenience which creates an instance of the ListResourcesRequest.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.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client
.listResourcesPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation.
listResourcesRequest - InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AwsServiceException, SdkClientException, LakeFormationException
Lists the resources registered to be managed by the Data Catalog.
This is a variant of
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client
.listResourcesPaginator(request);
for (software.amazon.awssdk.services.lakeformation.model.ListResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.lakeformation.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.lakeformation.model.ListResourcesRequest) operation.
This is a convenience which creates an instance of the ListResourcesRequest.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.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDataLakeSettingsResponse putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
putDataLakeSettingsRequest - InternalServiceException - An internal service error occurred.InvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutDataLakeSettingsResponse putDataLakeSettings(Consumer<PutDataLakeSettingsRequest.Builder> putDataLakeSettingsRequest) throws InternalServiceException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.
This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.
This is a convenience which creates an instance of the PutDataLakeSettingsRequest.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.InternalServiceException - An internal service error occurred.InvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterResourceResponse registerResource(RegisterResourceRequest registerResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AlreadyExistsException, AwsServiceException, SdkClientException, LakeFormationException
Registers the resource as managed by the Data Catalog.
To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
The following request registers a new location and gives 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 - InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AlreadyExistsException - A resource to be created or added already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterResourceResponse registerResource(Consumer<RegisterResourceRequest.Builder> registerResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, AlreadyExistsException, AwsServiceException, SdkClientException, LakeFormationException
Registers the resource as managed by the Data Catalog.
To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
The following request registers a new location and gives 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.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.AlreadyExistsException - A resource to be created or added already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RevokePermissionsResponse revokePermissions(RevokePermissionsRequest revokePermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
revokePermissionsRequest - ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RevokePermissionsResponse revokePermissions(Consumer<RevokePermissionsRequest.Builder> revokePermissionsRequest) throws ConcurrentModificationException, EntityNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, LakeFormationException
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
This is a convenience which creates an instance of the RevokePermissionsRequest.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.ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.EntityNotFoundException - A specified entity does not existInvalidInputException - The input provided was not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
updateResourceRequest - InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) throws InvalidInputException, InternalServiceException, OperationTimeoutException, EntityNotFoundException, AwsServiceException, SdkClientException, LakeFormationException
Updates the data access role used for vending access to the given (registered) resource in 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.InvalidInputException - The input provided was not valid.InternalServiceException - An internal service error occurred.OperationTimeoutException - The operation timed out.EntityNotFoundException - A specified entity does not existSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LakeFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.