AWSLakeFormation (AWS Java SDK for AWS Lake Formation 1.11.642 API)

All Known Subinterfaces:

AWSLakeFormationAsync

All Known Implementing Classes:

AbstractAWSLakeFormation, AbstractAWSLakeFormationAsync, AWSLakeFormationAsyncClient, AWSLakeFormationClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSLakeFormation
```
Interface for accessing AWS Lake Formation.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSLakeFormation instead.

AWS Lake Formation
Defines the public endpoint for the AWS Lake Formation service.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BatchGrantPermissionsResult`	`batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest)` Batch operation to grant permissions to the principal.
`BatchRevokePermissionsResult`	`batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest)` Batch operation to revoke permissions from the principal.
`DeregisterResourceResult`	`deregisterResource(DeregisterResourceRequest deregisterResourceRequest)` Deregisters the resource as managed by the Data Catalog.
`DescribeResourceResult`	`describeResource(DescribeResourceRequest describeResourceRequest)` 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 getDataLakeSettingsRequest)` The AWS Lake Formation principal.
`GetEffectivePermissionsForPathResult`	`getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)` Returns the permissions for a specified table or database resource located at a path in Amazon S3.
`GrantPermissionsResult`	`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.
`ListPermissionsResult`	`listPermissions(ListPermissionsRequest listPermissionsRequest)` Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
`ListResourcesResult`	`listResources(ListResourcesRequest listResourcesRequest)` Lists the resources registered to be managed by the Data Catalog.
`PutDataLakeSettingsResult`	`putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest)` The AWS Lake Formation principal.
`RegisterResourceResult`	`registerResource(RegisterResourceRequest registerResourceRequest)` Registers the resource as managed by the Data Catalog.
`RevokePermissionsResult`	`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.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateResourceResult`	`updateResource(UpdateResourceRequest updateResourceRequest)` Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchGrantPermissions
```
BatchGrantPermissionsResult batchGrantPermissions(BatchGrantPermissionsRequest batchGrantPermissionsRequest)
```
    Batch operation to grant permissions to the principal.
    
    Parameters:
    
    batchGrantPermissionsRequest -
    
    Returns:
    
    Result of the BatchGrantPermissions operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    See Also:
    
    AWS API Documentation
  - batchRevokePermissions
```
BatchRevokePermissionsResult batchRevokePermissions(BatchRevokePermissionsRequest batchRevokePermissionsRequest)
```
    Batch operation to revoke permissions from the principal.
    
    Parameters:
    
    batchRevokePermissionsRequest -
    
    Returns:
    
    Result of the BatchRevokePermissions operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    See Also:
    
    AWS API Documentation
  - deregisterResource
```
DeregisterResourceResult deregisterResource(DeregisterResourceRequest deregisterResourceRequest)
```
    Deregisters the resource as managed by the Data Catalog.
    
    When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.
    
    Parameters:
    
    deregisterResourceRequest -
    
    Returns:
    
    Result of the DeregisterResource operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    EntityNotFoundException - A specified entity does not exist
    
    See Also:
    
    AWS API Documentation
  - describeResource
```
DescribeResourceResult describeResource(DescribeResourceRequest describeResourceRequest)
```
    Retrieves the current data access role for the given resource registered in AWS Lake Formation.
    
    Parameters:
    
    describeResourceRequest -
    
    Returns:
    
    Result of the DescribeResource operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    EntityNotFoundException - A specified entity does not exist
    
    See Also:
    
    AWS API Documentation
  - getDataLakeSettings
```
GetDataLakeSettingsResult getDataLakeSettings(GetDataLakeSettingsRequest getDataLakeSettingsRequest)
```
    The AWS Lake Formation principal.
    
    Parameters:
    
    getDataLakeSettingsRequest -
    
    Returns:
    
    Result of the GetDataLakeSettings operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    EntityNotFoundException - A specified entity does not exist
    
    See Also:
    
    AWS API Documentation
  - getEffectivePermissionsForPath
```
GetEffectivePermissionsForPathResult getEffectivePermissionsForPath(GetEffectivePermissionsForPathRequest getEffectivePermissionsForPathRequest)
```
    Returns the permissions for a specified table or database resource located at a path in Amazon S3.
    
    Parameters:
    
    getEffectivePermissionsForPathRequest -
    
    Returns:
    
    Result of the GetEffectivePermissionsForPath operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    EntityNotFoundException - A specified entity does not exist
    
    OperationTimeoutException - The operation timed out.
    
    InternalServiceException - An internal service error occurred.
    
    See Also:
    
    AWS API Documentation
  - grantPermissions
```
GrantPermissionsResult grantPermissions(GrantPermissionsRequest grantPermissionsRequest)
```
    Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
    
    For information about permissions, see Security and Access Control to Metadata and Data.
    
    Parameters:
    
    grantPermissionsRequest -
    
    Returns:
    
    Result of the GrantPermissions operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    See Also:
    
    AWS API Documentation
  - listPermissions
```
ListPermissionsResult listPermissions(ListPermissionsRequest listPermissionsRequest)
```
    Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.
    
    This operation returns only those permissions that have been explicitly granted.
    
    For information about permissions, see Security and Access Control to Metadata and Data.
    
    Parameters:
    
    listPermissionsRequest -
    
    Returns:
    
    Result of the ListPermissions operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    OperationTimeoutException - The operation timed out.
    
    InternalServiceException - An internal service error occurred.
    
    See Also:
    
    AWS API Documentation
  - listResources
```
ListResourcesResult listResources(ListResourcesRequest listResourcesRequest)
```
    Lists the resources registered to be managed by the Data Catalog.
    
    Parameters:
    
    listResourcesRequest -
    
    Returns:
    
    Result of the ListResources operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    See Also:
    
    AWS API Documentation
  - putDataLakeSettings
```
PutDataLakeSettingsResult putDataLakeSettings(PutDataLakeSettingsRequest putDataLakeSettingsRequest)
```
    The AWS Lake Formation principal.
    
    Parameters:
    
    putDataLakeSettingsRequest -
    
    Returns:
    
    Result of the PutDataLakeSettings operation returned by the service.
    
    Throws:
    
    InternalServiceException - An internal service error occurred.
    
    InvalidInputException - The input provided was not valid.
    
    See Also:
    
    AWS API Documentation
  - registerResource
```
RegisterResourceResult registerResource(RegisterResourceRequest registerResourceRequest)
```
    Registers the resource as managed by the Data Catalog.
    
    To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
    
    Parameters:
    
    registerResourceRequest -
    
    Returns:
    
    Result of the RegisterResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - revokePermissions
```
RevokePermissionsResult 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.
    
    Parameters:
    
    revokePermissionsRequest -
    
    Returns:
    
    Result of the RevokePermissions operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - Two processes are trying to modify a resource simultaneously.
    
    EntityNotFoundException - A specified entity does not exist
    
    InvalidInputException - The input provided was not valid.
    
    See Also:
    
    AWS API Documentation
  - updateResource
```
UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)
```
    Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
    
    Parameters:
    
    updateResourceRequest -
    
    Returns:
    
    Result of the UpdateResource operation returned by the service.
    
    Throws:
    
    InvalidInputException - The input provided was not valid.
    
    InternalServiceException - An internal service error occurred.
    
    OperationTimeoutException - The operation timed out.
    
    EntityNotFoundException - A specified entity does not exist
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AWSLakeFormation

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchGrantPermissions

batchRevokePermissions

deregisterResource

describeResource

getDataLakeSettings

getEffectivePermissionsForPath

grantPermissions

listPermissions

listResources

putDataLakeSettings

registerResource

revokePermissions

updateResource

shutdown

getCachedResponseMetadata