@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSLakeFormation extends Object implements AWSLakeFormation
AWSLakeFormation. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
BatchGrantPermissionsResult |
batchGrantPermissions(BatchGrantPermissionsRequest request)
Batch operation to grant permissions to the principal.
|
BatchRevokePermissionsResult |
batchRevokePermissions(BatchRevokePermissionsRequest request)
Batch operation to revoke permissions from the principal.
|
DeregisterResourceResult |
deregisterResource(DeregisterResourceRequest request)
Deregisters the resource as managed by the Data Catalog.
|
DescribeResourceResult |
describeResource(DescribeResourceRequest request)
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDataLakeSettingsResult |
getDataLakeSettings(GetDataLakeSettingsRequest request)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
|
GetEffectivePermissionsForPathResult |
getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest request)
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
|
GrantPermissionsResult |
grantPermissions(GrantPermissionsRequest request)
Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data
storage such as Amazon S3.
|
ListPermissionsResult |
listPermissions(ListPermissionsRequest request)
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
|
ListResourcesResult |
listResources(ListResourcesRequest request)
Lists the resources registered to be managed by the Data Catalog.
|
PutDataLakeSettingsResult |
putDataLakeSettings(PutDataLakeSettingsRequest request)
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
|
RegisterResourceResult |
registerResource(RegisterResourceRequest request)
Registers the resource as managed by the Data Catalog.
|
RevokePermissionsResult |
revokePermissions(RevokePermissionsRequest request)
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data
storage such as Amazon S3.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest request)
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
|
public BatchGrantPermissionsResult batchGrantPermissions(BatchGrantPermissionsRequest request)
AWSLakeFormationBatch operation to grant permissions to the principal.
batchGrantPermissions in interface AWSLakeFormationpublic BatchRevokePermissionsResult batchRevokePermissions(BatchRevokePermissionsRequest request)
AWSLakeFormationBatch operation to revoke permissions from the principal.
batchRevokePermissions in interface AWSLakeFormationpublic DeregisterResourceResult deregisterResource(DeregisterResourceRequest request)
AWSLakeFormationDeregisters 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.
deregisterResource in interface AWSLakeFormationpublic DescribeResourceResult describeResource(DescribeResourceRequest request)
AWSLakeFormationRetrieves the current data access role for the given resource registered in AWS Lake Formation.
describeResource in interface AWSLakeFormationpublic GetDataLakeSettingsResult getDataLakeSettings(GetDataLakeSettingsRequest request)
AWSLakeFormationRetrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getDataLakeSettings in interface AWSLakeFormationpublic GetEffectivePermissionsForPathResult getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest request)
AWSLakeFormation
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.
getEffectivePermissionsForPath in interface AWSLakeFormationpublic GrantPermissionsResult grantPermissions(GrantPermissionsRequest request)
AWSLakeFormationGrants 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.
grantPermissions in interface AWSLakeFormationpublic ListPermissionsResult listPermissions(ListPermissionsRequest request)
AWSLakeFormationReturns 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.
listPermissions in interface AWSLakeFormationpublic ListResourcesResult listResources(ListResourcesRequest request)
AWSLakeFormationLists the resources registered to be managed by the Data Catalog.
listResources in interface AWSLakeFormationpublic PutDataLakeSettingsResult putDataLakeSettings(PutDataLakeSettingsRequest request)
AWSLakeFormationSets 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.
putDataLakeSettings in interface AWSLakeFormationpublic RegisterResourceResult registerResource(RegisterResourceRequest request)
AWSLakeFormationRegisters 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
registerResource in interface AWSLakeFormationpublic RevokePermissionsResult revokePermissions(RevokePermissionsRequest request)
AWSLakeFormationRevokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
revokePermissions in interface AWSLakeFormationpublic UpdateResourceResult updateResource(UpdateResourceRequest request)
AWSLakeFormationUpdates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
updateResource in interface AWSLakeFormationpublic void shutdown()
AWSLakeFormationshutdown in interface AWSLakeFormationpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSLakeFormationResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSLakeFormationrequest - The originally executed request.