Lake Formation
Defines the public endpoint for the Lake Formation service.
lakeformation(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- lakeformation(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| add_lf_tags_to_resource | Attaches one or more LF-tags to an existing resource |
| assume_decorated_role_with_saml | Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request |
| batch_grant_permissions | Batch operation to grant permissions to the principal |
| batch_revoke_permissions | Batch operation to revoke permissions from the principal |
| cancel_transaction | Attempts to cancel the specified transaction |
| commit_transaction | Attempts to commit the specified transaction |
| create_data_cells_filter | Creates a data cell filter to allow one to grant access to certain columns on certain rows |
| create_lake_formation_identity_center_configuration | Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources |
| create_lake_formation_opt_in | Enforce Lake Formation permissions for the given databases, tables, and principals |
| create_lf_tag | Creates an LF-tag with the specified name and values |
| delete_data_cells_filter | Deletes a data cell filter |
| delete_lake_formation_identity_center_configuration | Deletes an IAM Identity Center connection with Lake Formation |
| delete_lake_formation_opt_in | Remove the Lake Formation permissions enforcement of the given databases, tables, and principals |
| delete_lf_tag | Deletes the specified LF-tag given a key name |
| delete_objects_on_cancel | For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled |
| deregister_resource | Deregisters the resource as managed by the Data Catalog |
| describe_lake_formation_identity_center_configuration | Retrieves the instance ARN and application ARN for the connection |
| describe_resource | Retrieves the current data access role for the given resource registered in Lake Formation |
| describe_transaction | Returns the details of a single transaction |
| extend_transaction | Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted |
| get_data_cells_filter | Returns a data cells filter |
| get_data_lake_principal | Returns the identity of the invoking principal |
| get_data_lake_settings | Retrieves the list of the data lake administrators of a Lake Formation-managed data lake |
| get_effective_permissions_for_path | Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3 |
| get_lf_tag | Returns an LF-tag definition |
| get_query_state | Returns the state of a query previously submitted |
| get_query_statistics | Retrieves statistics on the planning and execution of a query |
| get_resource_lf_tags | Returns the LF-tags applied to a resource |
| get_table_objects | Returns the set of Amazon S3 objects that make up the specified governed table |
| get_temporary_glue_partition_credentials | This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition |
| get_temporary_glue_table_credentials | Allows a caller in a secure environment to assume a role with permission to access Amazon S3 |
| get_work_unit_results | Returns the work units resulting from the query |
| get_work_units | Retrieves the work units generated by the StartQueryPlanning operation |
| grant_permissions | Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3 |
| list_data_cells_filter | Lists all the data cell filters on a table |
| list_lake_formation_opt_ins | Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions |
| list_lf_tags | Lists LF-tags that the requester has permission to view |
| list_permissions | Returns a list of the principal permissions on the resource, filtered by the permissions of the caller |
| list_resources | Lists the resources registered to be managed by the Data Catalog |
| list_table_storage_optimizers | Returns the configuration of all storage optimizers associated with a specified table |
| list_transactions | Returns metadata about transactions and their status |
| put_data_lake_settings | Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation |
| register_resource | Registers the resource as managed by the Data Catalog |
| remove_lf_tags_from_resource | Removes an LF-tag from the resource |
| revoke_permissions | Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3 |
| search_databases_by_lf_tags | This operation allows a search on DATABASE resources by TagCondition |
| search_tables_by_lf_tags | This operation allows a search on TABLE resources by LFTags |
| start_query_planning | Submits a request to process a query statement |
| start_transaction | Starts a new transaction and returns its transaction ID |
| update_data_cells_filter | Updates a data cell filter |
| update_lake_formation_identity_center_configuration | Updates the IAM Identity Center connection parameters |
| update_lf_tag | Updates the list of possible values for the specified LF-tag key |
| update_resource | Updates the data access role used for vending access to the given (registered) resource in Lake Formation |
| update_table_objects | Updates the manifest of Amazon S3 objects that make up the specified governed table |
| update_table_storage_optimizer | Updates the configuration of the storage optimizers for a table |
if (FALSE) {
svc <- lakeformation()
svc$add_lf_tags_to_resource(
Foo = 123
)
}
Run the code above in your browser using DataLab