@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSLakeFormationClient extends AmazonWebServiceClient implements AWSLakeFormation
Defines the public endpoint for the AWS Lake Formation service.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddLFTagsToResourceResult |
addLFTagsToResource(AddLFTagsToResourceRequest request)
Attaches one or more tags to an existing resource.
|
BatchGrantPermissionsResult |
batchGrantPermissions(BatchGrantPermissionsRequest request)
Batch operation to grant permissions to the principal.
|
BatchRevokePermissionsResult |
batchRevokePermissions(BatchRevokePermissionsRequest request)
Batch operation to revoke permissions from the principal.
|
static AWSLakeFormationClientBuilder |
builder() |
CreateLFTagResult |
createLFTag(CreateLFTagRequest request)
Creates a tag with the specified name and values.
|
DeleteLFTagResult |
deleteLFTag(DeleteLFTagRequest request)
Deletes the specified tag key name.
|
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.
|
GetLFTagResult |
getLFTag(GetLFTagRequest request)
Returns a tag definition.
|
GetResourceLFTagsResult |
getResourceLFTags(GetResourceLFTagsRequest request)
Returns the tags applied to a resource.
|
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.
|
ListLFTagsResult |
listLFTags(ListLFTagsRequest request)
Lists tags that the requester has permission to view.
|
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.
|
RemoveLFTagsFromResourceResult |
removeLFTagsFromResource(RemoveLFTagsFromResourceRequest request)
Removes a tag from the resource.
|
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.
|
SearchDatabasesByLFTagsResult |
searchDatabasesByLFTags(SearchDatabasesByLFTagsRequest request)
This operation allows a search on
DATABASE resources by TagCondition . |
SearchTablesByLFTagsResult |
searchTablesByLFTags(SearchTablesByLFTagsRequest request)
This operation allows a search on
TABLE resources by LFTag s. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
UpdateLFTagResult |
updateLFTag(UpdateLFTagRequest request)
Updates the list of possible values for the specified tag key.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest request)
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSLakeFormationClientBuilder builder()
public AddLFTagsToResourceResult addLFTagsToResource(AddLFTagsToResourceRequest request)
Attaches one or more tags to an existing resource.
addLFTagsToResource
in interface AWSLakeFormation
addLFTagsToResourceRequest
- EntityNotFoundException
- A specified entity does not existInvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.AccessDeniedException
- Access to a resource was denied.ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.public BatchGrantPermissionsResult batchGrantPermissions(BatchGrantPermissionsRequest request)
Batch operation to grant permissions to the principal.
batchGrantPermissions
in interface AWSLakeFormation
batchGrantPermissionsRequest
- InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.public BatchRevokePermissionsResult batchRevokePermissions(BatchRevokePermissionsRequest request)
Batch operation to revoke permissions from the principal.
batchRevokePermissions
in interface AWSLakeFormation
batchRevokePermissionsRequest
- InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.public CreateLFTagResult createLFTag(CreateLFTagRequest request)
Creates a tag with the specified name and values.
createLFTag
in interface AWSLakeFormation
createLFTagRequest
- EntityNotFoundException
- A specified entity does not existInvalidInputException
- The input provided was not valid.ResourceNumberLimitExceededException
- A resource numerical limit was exceeded.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.AccessDeniedException
- Access to a resource was denied.public DeleteLFTagResult deleteLFTag(DeleteLFTagRequest request)
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.
deleteLFTag
in interface AWSLakeFormation
deleteLFTagRequest
- EntityNotFoundException
- A specified entity does not existInvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.AccessDeniedException
- Access to a resource was denied.public DeregisterResourceResult deregisterResource(DeregisterResourceRequest request)
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.
deregisterResource
in interface AWSLakeFormation
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 existpublic DescribeResourceResult describeResource(DescribeResourceRequest request)
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
describeResource
in interface AWSLakeFormation
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 existpublic GetDataLakeSettingsResult getDataLakeSettings(GetDataLakeSettingsRequest request)
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getDataLakeSettings
in interface AWSLakeFormation
getDataLakeSettingsRequest
- InternalServiceException
- An internal service error occurred.InvalidInputException
- The input provided was not valid.EntityNotFoundException
- A specified entity does not existpublic GetEffectivePermissionsForPathResult getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest request)
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 AWSLakeFormation
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.public GetLFTagResult getLFTag(GetLFTagRequest request)
Returns a tag definition.
getLFTag
in interface AWSLakeFormation
getLFTagRequest
- EntityNotFoundException
- A specified entity does not existInvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.AccessDeniedException
- Access to a resource was denied.public GetResourceLFTagsResult getResourceLFTags(GetResourceLFTagsRequest request)
Returns the tags applied to a resource.
getResourceLFTags
in interface AWSLakeFormation
getResourceLFTagsRequest
- EntityNotFoundException
- A specified entity does not existInvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.GlueEncryptionException
- An encryption operation failed.AccessDeniedException
- Access to a resource was denied.public 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.
For information about permissions, see Security and Access Control to Metadata and Data.
grantPermissions
in interface AWSLakeFormation
grantPermissionsRequest
- ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.EntityNotFoundException
- A specified entity does not existInvalidInputException
- The input provided was not valid.public ListLFTagsResult listLFTags(ListLFTagsRequest request)
Lists tags that the requester has permission to view.
listLFTags
in interface AWSLakeFormation
listLFTagsRequest
- EntityNotFoundException
- A specified entity does not existInvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.public ListPermissionsResult listPermissions(ListPermissionsRequest request)
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.
listPermissions
in interface AWSLakeFormation
listPermissionsRequest
- InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.InternalServiceException
- An internal service error occurred.public ListResourcesResult listResources(ListResourcesRequest request)
Lists the resources registered to be managed by the Data Catalog.
listResources
in interface AWSLakeFormation
listResourcesRequest
- InvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.public PutDataLakeSettingsResult putDataLakeSettings(PutDataLakeSettingsRequest request)
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.
putDataLakeSettings
in interface AWSLakeFormation
putDataLakeSettingsRequest
- InternalServiceException
- An internal service error occurred.InvalidInputException
- The input provided was not valid.public RegisterResourceResult registerResource(RegisterResourceRequest request)
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
registerResource
in interface AWSLakeFormation
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.public RemoveLFTagsFromResourceResult removeLFTagsFromResource(RemoveLFTagsFromResourceRequest request)
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.
removeLFTagsFromResource
in interface AWSLakeFormation
removeLFTagsFromResourceRequest
- EntityNotFoundException
- A specified entity does not existInvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.GlueEncryptionException
- An encryption operation failed.AccessDeniedException
- Access to a resource was denied.ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.public 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.
revokePermissions
in interface AWSLakeFormation
revokePermissionsRequest
- ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.EntityNotFoundException
- A specified entity does not existInvalidInputException
- The input provided was not valid.public SearchDatabasesByLFTagsResult searchDatabasesByLFTags(SearchDatabasesByLFTagsRequest request)
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.
searchDatabasesByLFTags
in interface AWSLakeFormation
searchDatabasesByLFTagsRequest
- EntityNotFoundException
- A specified entity does not existInternalServiceException
- An internal service error occurred.InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.GlueEncryptionException
- An encryption operation failed.AccessDeniedException
- Access to a resource was denied.public SearchTablesByLFTagsResult searchTablesByLFTags(SearchTablesByLFTagsRequest request)
This operation allows a search on TABLE
resources by LFTag
s. 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 LFTag
s are valid to verify
whether the returned resources can be shared.
searchTablesByLFTags
in interface AWSLakeFormation
searchTablesByLFTagsRequest
- EntityNotFoundException
- A specified entity does not existInternalServiceException
- An internal service error occurred.InvalidInputException
- The input provided was not valid.OperationTimeoutException
- The operation timed out.GlueEncryptionException
- An encryption operation failed.AccessDeniedException
- Access to a resource was denied.public UpdateLFTagResult updateLFTag(UpdateLFTagRequest request)
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.
updateLFTag
in interface AWSLakeFormation
updateLFTagRequest
- EntityNotFoundException
- A specified entity does not existInvalidInputException
- The input provided was not valid.InternalServiceException
- An internal service error occurred.OperationTimeoutException
- The operation timed out.ConcurrentModificationException
- Two processes are trying to modify a resource simultaneously.AccessDeniedException
- Access to a resource was denied.public UpdateResourceResult updateResource(UpdateResourceRequest request)
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
updateResource
in interface AWSLakeFormation
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 existpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response 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 the request.
getCachedResponseMetadata
in interface AWSLakeFormation
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSLakeFormation
shutdown
in class AmazonWebServiceClient