@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSLakeFormationAsync extends AWSLakeFormation
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSLakeFormationAsync
instead.
Defines the public endpoint for the AWS Lake Formation service.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<BatchGrantPermissionsResult> |
batchGrantPermissionsAsync(BatchGrantPermissionsRequest batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
|
Future<BatchGrantPermissionsResult> |
batchGrantPermissionsAsync(BatchGrantPermissionsRequest batchGrantPermissionsRequest,
AsyncHandler<BatchGrantPermissionsRequest,BatchGrantPermissionsResult> asyncHandler)
Batch operation to grant permissions to the principal.
|
Future<BatchRevokePermissionsResult> |
batchRevokePermissionsAsync(BatchRevokePermissionsRequest batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
|
Future<BatchRevokePermissionsResult> |
batchRevokePermissionsAsync(BatchRevokePermissionsRequest batchRevokePermissionsRequest,
AsyncHandler<BatchRevokePermissionsRequest,BatchRevokePermissionsResult> asyncHandler)
Batch operation to revoke permissions from the principal.
|
Future<DeregisterResourceResult> |
deregisterResourceAsync(DeregisterResourceRequest deregisterResourceRequest)
Deregisters the resource as managed by the Data Catalog.
|
Future<DeregisterResourceResult> |
deregisterResourceAsync(DeregisterResourceRequest deregisterResourceRequest,
AsyncHandler<DeregisterResourceRequest,DeregisterResourceResult> asyncHandler)
Deregisters the resource as managed by the Data Catalog.
|
Future<DescribeResourceResult> |
describeResourceAsync(DescribeResourceRequest describeResourceRequest)
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
|
Future<DescribeResourceResult> |
describeResourceAsync(DescribeResourceRequest describeResourceRequest,
AsyncHandler<DescribeResourceRequest,DescribeResourceResult> asyncHandler)
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
|
Future<GetDataLakeSettingsResult> |
getDataLakeSettingsAsync(GetDataLakeSettingsRequest getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
|
Future<GetDataLakeSettingsResult> |
getDataLakeSettingsAsync(GetDataLakeSettingsRequest getDataLakeSettingsRequest,
AsyncHandler<GetDataLakeSettingsRequest,GetDataLakeSettingsResult> asyncHandler)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
|
Future<GetEffectivePermissionsForPathResult> |
getEffectivePermissionsForPathAsync(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
Future<GetEffectivePermissionsForPathResult> |
getEffectivePermissionsForPathAsync(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest,
AsyncHandler<GetEffectivePermissionsForPathRequest,GetEffectivePermissionsForPathResult> asyncHandler)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
Future<GrantPermissionsResult> |
grantPermissionsAsync(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.
|
Future<GrantPermissionsResult> |
grantPermissionsAsync(GrantPermissionsRequest grantPermissionsRequest,
AsyncHandler<GrantPermissionsRequest,GrantPermissionsResult> asyncHandler)
Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data
storage such as Amazon S3.
|
Future<ListPermissionsResult> |
listPermissionsAsync(ListPermissionsRequest listPermissionsRequest)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
Future<ListPermissionsResult> |
listPermissionsAsync(ListPermissionsRequest listPermissionsRequest,
AsyncHandler<ListPermissionsRequest,ListPermissionsResult> asyncHandler)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
Future<ListResourcesResult> |
listResourcesAsync(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
|
Future<ListResourcesResult> |
listResourcesAsync(ListResourcesRequest listResourcesRequest,
AsyncHandler<ListResourcesRequest,ListResourcesResult> asyncHandler)
Lists the resources registered to be managed by the Data Catalog.
|
Future<PutDataLakeSettingsResult> |
putDataLakeSettingsAsync(PutDataLakeSettingsRequest putDataLakeSettingsRequest)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
|
Future<PutDataLakeSettingsResult> |
putDataLakeSettingsAsync(PutDataLakeSettingsRequest putDataLakeSettingsRequest,
AsyncHandler<PutDataLakeSettingsRequest,PutDataLakeSettingsResult> asyncHandler)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
|
Future<RegisterResourceResult> |
registerResourceAsync(RegisterResourceRequest registerResourceRequest)
Registers the resource as managed by the Data Catalog.
|
Future<RegisterResourceResult> |
registerResourceAsync(RegisterResourceRequest registerResourceRequest,
AsyncHandler<RegisterResourceRequest,RegisterResourceResult> asyncHandler)
Registers the resource as managed by the Data Catalog.
|
Future<RevokePermissionsResult> |
revokePermissionsAsync(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.
|
Future<RevokePermissionsResult> |
revokePermissionsAsync(RevokePermissionsRequest revokePermissionsRequest,
AsyncHandler<RevokePermissionsRequest,RevokePermissionsResult> asyncHandler)
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data
storage such as Amazon S3.
|
Future<UpdateResourceResult> |
updateResourceAsync(UpdateResourceRequest updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
|
Future<UpdateResourceResult> |
updateResourceAsync(UpdateResourceRequest updateResourceRequest,
AsyncHandler<UpdateResourceRequest,UpdateResourceResult> asyncHandler)
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
|
batchGrantPermissions, batchRevokePermissions, deregisterResource, describeResource, getCachedResponseMetadata, getDataLakeSettings, getEffectivePermissionsForPath, grantPermissions, listPermissions, listResources, putDataLakeSettings, registerResource, revokePermissions, shutdown, updateResource
Future<BatchGrantPermissionsResult> batchGrantPermissionsAsync(BatchGrantPermissionsRequest batchGrantPermissionsRequest)
Batch operation to grant permissions to the principal.
batchGrantPermissionsRequest
- Future<BatchGrantPermissionsResult> batchGrantPermissionsAsync(BatchGrantPermissionsRequest batchGrantPermissionsRequest, AsyncHandler<BatchGrantPermissionsRequest,BatchGrantPermissionsResult> asyncHandler)
Batch operation to grant permissions to the principal.
batchGrantPermissionsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchRevokePermissionsResult> batchRevokePermissionsAsync(BatchRevokePermissionsRequest batchRevokePermissionsRequest)
Batch operation to revoke permissions from the principal.
batchRevokePermissionsRequest
- Future<BatchRevokePermissionsResult> batchRevokePermissionsAsync(BatchRevokePermissionsRequest batchRevokePermissionsRequest, AsyncHandler<BatchRevokePermissionsRequest,BatchRevokePermissionsResult> asyncHandler)
Batch operation to revoke permissions from the principal.
batchRevokePermissionsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeregisterResourceResult> deregisterResourceAsync(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
- Future<DeregisterResourceResult> deregisterResourceAsync(DeregisterResourceRequest deregisterResourceRequest, AsyncHandler<DeregisterResourceRequest,DeregisterResourceResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeResourceResult> describeResourceAsync(DescribeResourceRequest describeResourceRequest)
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
describeResourceRequest
- Future<DescribeResourceResult> describeResourceAsync(DescribeResourceRequest describeResourceRequest, AsyncHandler<DescribeResourceRequest,DescribeResourceResult> asyncHandler)
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
describeResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDataLakeSettingsResult> getDataLakeSettingsAsync(GetDataLakeSettingsRequest getDataLakeSettingsRequest)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getDataLakeSettingsRequest
- Future<GetDataLakeSettingsResult> getDataLakeSettingsAsync(GetDataLakeSettingsRequest getDataLakeSettingsRequest, AsyncHandler<GetDataLakeSettingsRequest,GetDataLakeSettingsResult> asyncHandler)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getDataLakeSettingsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetEffectivePermissionsForPathResult> getEffectivePermissionsForPathAsync(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
- Future<GetEffectivePermissionsForPathResult> getEffectivePermissionsForPathAsync(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest, AsyncHandler<GetEffectivePermissionsForPathRequest,GetEffectivePermissionsForPathResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GrantPermissionsResult> grantPermissionsAsync(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
- Future<GrantPermissionsResult> grantPermissionsAsync(GrantPermissionsRequest grantPermissionsRequest, AsyncHandler<GrantPermissionsRequest,GrantPermissionsResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPermissionsResult> listPermissionsAsync(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
- Future<ListPermissionsResult> listPermissionsAsync(ListPermissionsRequest listPermissionsRequest, AsyncHandler<ListPermissionsRequest,ListPermissionsResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest listResourcesRequest)
Lists the resources registered to be managed by the Data Catalog.
listResourcesRequest
- Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest listResourcesRequest, AsyncHandler<ListResourcesRequest,ListResourcesResult> asyncHandler)
Lists the resources registered to be managed by the Data Catalog.
listResourcesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutDataLakeSettingsResult> putDataLakeSettingsAsync(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
- Future<PutDataLakeSettingsResult> putDataLakeSettingsAsync(PutDataLakeSettingsRequest putDataLakeSettingsRequest, AsyncHandler<PutDataLakeSettingsRequest,PutDataLakeSettingsResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RegisterResourceResult> registerResourceAsync(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
- Future<RegisterResourceResult> registerResourceAsync(RegisterResourceRequest registerResourceRequest, AsyncHandler<RegisterResourceRequest,RegisterResourceResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RevokePermissionsResult> revokePermissionsAsync(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
- Future<RevokePermissionsResult> revokePermissionsAsync(RevokePermissionsRequest revokePermissionsRequest, AsyncHandler<RevokePermissionsRequest,RevokePermissionsResult> asyncHandler)
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
revokePermissionsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest updateResourceRequest)
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
updateResourceRequest
- Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest updateResourceRequest, AsyncHandler<UpdateResourceRequest,UpdateResourceResult> asyncHandler)
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
updateResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.