Expand description
Defines the public endpoint for the AWS Lake Formation service.
If you’re using the service, you’re probably looking for LakeFormationClient and LakeFormation.
Structs§
- AddLF
Tags ToResource Request - AddLF
Tags ToResource Response - Batch
Grant Permissions Request - Batch
Grant Permissions Response - Batch
Permissions Failure Entry A list of failures when performing a batch grant or batch revoke operation.
- Batch
Permissions Request Entry A permission to a resource granted by batch operation to the principal.
- Batch
Revoke Permissions Request - Batch
Revoke Permissions Response - Catalog
Resource A structure for the catalog object.
- ColumnLF
Tag A structure containing the name of a column resource and the tags attached to it.
- Column
Wildcard A wildcard object, consisting of an optional list of excluded column names or indexes.
- CreateLF
TagRequest - CreateLF
TagResponse - Data
Lake Principal The AWS Lake Formation principal. Supported principals are IAM users or IAM roles.
- Data
Lake Settings A structure representing a list of AWS Lake Formation principals designated as data lake administrators and lists of principal permission entries for default create database and default create table permissions.
- Data
Location Resource A structure for a data location object where permissions are granted or revoked.
- Database
Resource A structure for the database object.
- DeleteLF
TagRequest - DeleteLF
TagResponse - Deregister
Resource Request - Deregister
Resource Response - Describe
Resource Request - Describe
Resource Response - Details
Map A structure containing the additional details to be returned in the
AdditionalDetailsattribute ofPrincipalResourcePermissions.If a catalog resource is shared through AWS Resource Access Manager (AWS RAM), then there will exist a corresponding RAM resource share ARN.
- Error
Detail Contains details about an error.
- Filter
Condition This structure describes the filtering of columns in a table based on a filter condition.
- GetData
Lake Settings Request - GetData
Lake Settings Response - GetEffective
Permissions ForPath Request - GetEffective
Permissions ForPath Response - GetLF
TagRequest - GetLF
TagResponse - GetResourceLF
Tags Request - GetResourceLF
Tags Response - Grant
Permissions Request - Grant
Permissions Response - LFTag
A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns not tagged 'PII' of tables tagged 'Prod'.
- LFTag
Error A structure containing an error related to a
TagResourceorUnTagResourceoperation.- LFTag
KeyResource A structure containing a tag key and values for a resource.
- LFTag
Pair A structure containing a tag key-value pair.
- LFTag
Policy Resource A structure containing a list of tag conditions that apply to a resource's tag policy.
- Lake
Formation Client - A client for the AWS Lake Formation API.
- ListLF
Tags Request - ListLF
Tags Response - List
Permissions Request - List
Permissions Response - List
Resources Request - List
Resources Response - Principal
Permissions Permissions granted to a principal.
- Principal
Resource Permissions The permissions granted or revoked on a resource.
- PutData
Lake Settings Request - PutData
Lake Settings Response - Register
Resource Request - Register
Resource Response - RemoveLF
Tags From Resource Request - RemoveLF
Tags From Resource Response - Resource
A structure for the resource.
- Resource
Info A structure containing information about an AWS Lake Formation resource.
- Revoke
Permissions Request - Revoke
Permissions Response - Search
Databases ByLF Tags Request - Search
Databases ByLF Tags Response - Search
Tables ByLF Tags Request - Search
Tables ByLF Tags Response - Table
Resource A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
- Table
Wildcard A wildcard object representing every table under a database.
- Table
With Columns Resource A structure for a table with columns object. This object is only used when granting a SELECT permission.
This object must take a value for at least one of
ColumnsNames,ColumnsIndexes, orColumnsWildcard.- Tagged
Database A structure describing a database resource with tags.
- Tagged
Table A structure describing a table resource with tags.
- UpdateLF
TagRequest - UpdateLF
TagResponse - Update
Resource Request - Update
Resource Response
Enums§
- AddLF
Tags ToResource Error - Errors returned by AddLFTagsToResource
- Batch
Grant Permissions Error - Errors returned by BatchGrantPermissions
- Batch
Revoke Permissions Error - Errors returned by BatchRevokePermissions
- CreateLF
TagError - Errors returned by CreateLFTag
- DeleteLF
TagError - Errors returned by DeleteLFTag
- Deregister
Resource Error - Errors returned by DeregisterResource
- Describe
Resource Error - Errors returned by DescribeResource
- GetData
Lake Settings Error - Errors returned by GetDataLakeSettings
- GetEffective
Permissions ForPath Error - Errors returned by GetEffectivePermissionsForPath
- GetLF
TagError - Errors returned by GetLFTag
- GetResourceLF
Tags Error - Errors returned by GetResourceLFTags
- Grant
Permissions Error - Errors returned by GrantPermissions
- ListLF
Tags Error - Errors returned by ListLFTags
- List
Permissions Error - Errors returned by ListPermissions
- List
Resources Error - Errors returned by ListResources
- PutData
Lake Settings Error - Errors returned by PutDataLakeSettings
- Register
Resource Error - Errors returned by RegisterResource
- RemoveLF
Tags From Resource Error - Errors returned by RemoveLFTagsFromResource
- Revoke
Permissions Error - Errors returned by RevokePermissions
- Search
Databases ByLF Tags Error - Errors returned by SearchDatabasesByLFTags
- Search
Tables ByLF Tags Error - Errors returned by SearchTablesByLFTags
- UpdateLF
TagError - Errors returned by UpdateLFTag
- Update
Resource Error - Errors returned by UpdateResource
Traits§
- Lake
Formation - Trait representing the capabilities of the AWS Lake Formation API. AWS Lake Formation clients implement this trait.