AWS.LakeFormation (aws-elixir v0.8.0) View Source

AWS Lake Formation

Defines the public endpoint for the AWS Lake Formation service.

Link to this section Summary

Functions

Attaches one or more tags to an existing resource.

Batch operation to grant permissions to the principal.

Batch operation to revoke permissions from the principal.

Creates a tag with the specified name and values.

Deletes the specified tag key name.

Deregisters the resource as managed by the Data Catalog.

Retrieves the current data access role for the given resource registered in AWS Lake Formation.

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.

Returns a tag definition.

Returns the tags applied to a resource.

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

Lists tags that the requester has permission to view.

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.

Lists the resources registered to be managed by the Data Catalog.

Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.

Registers the resource as managed by the Data Catalog.

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

This operation allows a search on DATABASE resources by TagCondition.

This operation allows a search on TABLE resources by LFTags.

Updates the list of possible values for the specified tag key.

Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.

Link to this section Functions

Link to this function

add_l_f_tags_to_resource(client, input, options \\ [])

View Source

Attaches one or more tags to an existing resource.

Link to this function

batch_grant_permissions(client, input, options \\ [])

View Source

Batch operation to grant permissions to the principal.

Link to this function

batch_revoke_permissions(client, input, options \\ [])

View Source

Batch operation to revoke permissions from the principal.

Link to this function

create_l_f_tag(client, input, options \\ [])

View Source

Creates a tag with the specified name and values.

Link to this function

delete_l_f_tag(client, input, options \\ [])

View Source

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.

Link to this function

deregister_resource(client, input, options \\ [])

View Source

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.

Link to this function

describe_resource(client, input, options \\ [])

View Source

Retrieves the current data access role for the given resource registered in AWS Lake Formation.

Link to this function

get_data_lake_settings(client, input, options \\ [])

View Source

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

Link to this function

get_effective_permissions_for_path(client, input, options \\ [])

View Source

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.

Link to this function

get_l_f_tag(client, input, options \\ [])

View Source

Returns a tag definition.

Link to this function

get_resource_l_f_tags(client, input, options \\ [])

View Source

Returns the tags applied to a resource.

Link to this function

grant_permissions(client, input, options \\ [])

View Source

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.

Link to this function

list_l_f_tags(client, input, options \\ [])

View Source

Lists tags that the requester has permission to view.

Link to this function

list_permissions(client, input, options \\ [])

View Source

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.

Link to this function

list_resources(client, input, options \\ [])

View Source

Lists the resources registered to be managed by the Data Catalog.

Link to this function

put_data_lake_settings(client, input, options \\ [])

View Source

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.

Link to this function

register_resource(client, input, options \\ [])

View Source

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

Link to this function

remove_l_f_tags_from_resource(client, input, options \\ [])

View Source

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.

Link to this function

revoke_permissions(client, input, options \\ [])

View Source

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

Link to this function

search_databases_by_l_f_tags(client, input, options \\ [])

View Source

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.

Link to this function

search_tables_by_l_f_tags(client, input, options \\ [])

View Source

This operation allows a search on TABLE resources by LFTags.

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 LFTags are valid to verify whether the returned resources can be shared.

Link to this function

update_l_f_tag(client, input, options \\ [])

View Source

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.

Link to this function

update_resource(client, input, options \\ [])

View Source

Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.