Class: Aws::LakeFormation::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::LakeFormation::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb
Overview
An API client for LakeFormation. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::LakeFormation::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_lf_tags_to_resource(params = {}) ⇒ Types::AddLFTagsToResourceResponse
Attaches one or more LF-tags to an existing resource.
-
#assume_decorated_role_with_saml(params = {}) ⇒ Types::AssumeDecoratedRoleWithSAMLResponse
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(params = {}) ⇒ Types::BatchGrantPermissionsResponse
Batch operation to grant permissions to the principal.
-
#batch_revoke_permissions(params = {}) ⇒ Types::BatchRevokePermissionsResponse
Batch operation to revoke permissions from the principal.
-
#cancel_transaction(params = {}) ⇒ Struct
Attempts to cancel the specified transaction.
-
#commit_transaction(params = {}) ⇒ Types::CommitTransactionResponse
Attempts to commit the specified transaction.
-
#create_data_cells_filter(params = {}) ⇒ Struct
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
-
#create_lake_formation_identity_center_configuration(params = {}) ⇒ Types::CreateLakeFormationIdentityCenterConfigurationResponse
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(params = {}) ⇒ Struct
Enforce Lake Formation permissions for the given databases, tables, and principals.
-
#create_lf_tag(params = {}) ⇒ Struct
Creates an LF-tag with the specified name and values.
-
#delete_data_cells_filter(params = {}) ⇒ Struct
Deletes a data cell filter.
-
#delete_lake_formation_identity_center_configuration(params = {}) ⇒ Struct
Deletes an IAM Identity Center connection with Lake Formation.
-
#delete_lake_formation_opt_in(params = {}) ⇒ Struct
Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
-
#delete_lf_tag(params = {}) ⇒ Struct
Deletes the specified LF-tag given a key name.
-
#delete_objects_on_cancel(params = {}) ⇒ Struct
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(params = {}) ⇒ Struct
Deregisters the resource as managed by the Data Catalog.
-
#describe_lake_formation_identity_center_configuration(params = {}) ⇒ Types::DescribeLakeFormationIdentityCenterConfigurationResponse
Retrieves the instance ARN and application ARN for the connection.
-
#describe_resource(params = {}) ⇒ Types::DescribeResourceResponse
Retrieves the current data access role for the given resource registered in Lake Formation.
-
#describe_transaction(params = {}) ⇒ Types::DescribeTransactionResponse
Returns the details of a single transaction.
-
#extend_transaction(params = {}) ⇒ Struct
Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
-
#get_data_cells_filter(params = {}) ⇒ Types::GetDataCellsFilterResponse
Returns a data cells filter.
-
#get_data_lake_settings(params = {}) ⇒ Types::GetDataLakeSettingsResponse
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
-
#get_effective_permissions_for_path(params = {}) ⇒ Types::GetEffectivePermissionsForPathResponse
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
-
#get_lf_tag(params = {}) ⇒ Types::GetLFTagResponse
Returns an LF-tag definition.
-
#get_query_state(params = {}) ⇒ Types::GetQueryStateResponse
Returns the state of a query previously submitted.
-
#get_query_statistics(params = {}) ⇒ Types::GetQueryStatisticsResponse
Retrieves statistics on the planning and execution of a query.
-
#get_resource_lf_tags(params = {}) ⇒ Types::GetResourceLFTagsResponse
Returns the LF-tags applied to a resource.
-
#get_table_objects(params = {}) ⇒ Types::GetTableObjectsResponse
Returns the set of Amazon S3 objects that make up the specified governed table.
-
#get_temporary_glue_partition_credentials(params = {}) ⇒ Types::GetTemporaryGluePartitionCredentialsResponse
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(params = {}) ⇒ Types::GetTemporaryGlueTableCredentialsResponse
Allows a caller in a secure environment to assume a role with permission to access Amazon S3.
-
#get_work_unit_results(params = {}) ⇒ Types::GetWorkUnitResultsResponse
Returns the work units resulting from the query.
-
#get_work_units(params = {}) ⇒ Types::GetWorkUnitsResponse
Retrieves the work units generated by the
StartQueryPlanning
operation. -
#grant_permissions(params = {}) ⇒ Struct
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(params = {}) ⇒ Types::ListDataCellsFilterResponse
Lists all the data cell filters on a table.
-
#list_lake_formation_opt_ins(params = {}) ⇒ Types::ListLakeFormationOptInsResponse
Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
-
#list_lf_tags(params = {}) ⇒ Types::ListLFTagsResponse
Lists LF-tags that the requester has permission to view.
-
#list_permissions(params = {}) ⇒ Types::ListPermissionsResponse
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
-
#list_resources(params = {}) ⇒ Types::ListResourcesResponse
Lists the resources registered to be managed by the Data Catalog.
-
#list_table_storage_optimizers(params = {}) ⇒ Types::ListTableStorageOptimizersResponse
Returns the configuration of all storage optimizers associated with a specified table.
-
#list_transactions(params = {}) ⇒ Types::ListTransactionsResponse
Returns metadata about transactions and their status.
-
#put_data_lake_settings(params = {}) ⇒ Struct
Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.
-
#register_resource(params = {}) ⇒ Struct
Registers the resource as managed by the Data Catalog.
-
#remove_lf_tags_from_resource(params = {}) ⇒ Types::RemoveLFTagsFromResourceResponse
Removes an LF-tag from the resource.
-
#revoke_permissions(params = {}) ⇒ Struct
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(params = {}) ⇒ Types::SearchDatabasesByLFTagsResponse
This operation allows a search on
DATABASE
resources byTagCondition
. -
#search_tables_by_lf_tags(params = {}) ⇒ Types::SearchTablesByLFTagsResponse
This operation allows a search on
TABLE
resources byLFTag
s. -
#start_query_planning(params = {}) ⇒ Types::StartQueryPlanningResponse
Submits a request to process a query statement.
-
#start_transaction(params = {}) ⇒ Types::StartTransactionResponse
Starts a new transaction and returns its transaction ID.
-
#update_data_cells_filter(params = {}) ⇒ Struct
Updates a data cell filter.
-
#update_lake_formation_identity_center_configuration(params = {}) ⇒ Struct
Updates the IAM Identity Center connection parameters.
-
#update_lf_tag(params = {}) ⇒ Struct
Updates the list of possible values for the specified LF-tag key.
-
#update_resource(params = {}) ⇒ Struct
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
-
#update_table_objects(params = {}) ⇒ Struct
Updates the manifest of Amazon S3 objects that make up the specified governed table.
-
#update_table_storage_optimizer(params = {}) ⇒ Types::UpdateTableStorageOptimizerResponse
Updates the configuration of the storage optimizers for a table.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
409 410 411 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#add_lf_tags_to_resource(params = {}) ⇒ Types::AddLFTagsToResourceResponse
Attaches one or more LF-tags to an existing resource.
509 510 511 512 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 509 def (params = {}, = {}) req = build_request(:add_lf_tags_to_resource, params) req.send_request() end |
#assume_decorated_role_with_saml(params = {}) ⇒ Types::AssumeDecoratedRoleWithSAMLResponse
Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session.
This decorated role is expected to access data in Amazon S3 by getting
temporary access from Lake Formation which is authorized via the
virtual API GetDataAccess
. Therefore, all SAML roles that can be
assumed via AssumeDecoratedRoleWithSAML
must at a minimum include
lakeformation:GetDataAccess
in their role policies. A typical IAM
policy attached to such a role would look as follows:
576 577 578 579 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 576 def assume_decorated_role_with_saml(params = {}, = {}) req = build_request(:assume_decorated_role_with_saml, params) req.send_request() end |
#batch_grant_permissions(params = {}) ⇒ Types::BatchGrantPermissionsResponse
Batch operation to grant permissions to the principal.
706 707 708 709 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 706 def (params = {}, = {}) req = build_request(:batch_grant_permissions, params) req.send_request() end |
#batch_revoke_permissions(params = {}) ⇒ Types::BatchRevokePermissionsResponse
Batch operation to revoke permissions from the principal.
836 837 838 839 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 836 def (params = {}, = {}) req = build_request(:batch_revoke_permissions, params) req.send_request() end |
#cancel_transaction(params = {}) ⇒ Struct
Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
859 860 861 862 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 859 def cancel_transaction(params = {}, = {}) req = build_request(:cancel_transaction, params) req.send_request() end |
#commit_transaction(params = {}) ⇒ Types::CommitTransactionResponse
Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction.
889 890 891 892 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 889 def commit_transaction(params = {}, = {}) req = build_request(:commit_transaction, params) req.send_request() end |
#create_data_cells_filter(params = {}) ⇒ Struct
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
928 929 930 931 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 928 def create_data_cells_filter(params = {}, = {}) req = build_request(:create_data_cells_filter, params) req.send_request() end |
#create_lake_formation_identity_center_configuration(params = {}) ⇒ Types::CreateLakeFormationIdentityCenterConfigurationResponse
Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
1026 1027 1028 1029 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1026 def create_lake_formation_identity_center_configuration(params = {}, = {}) req = build_request(:create_lake_formation_identity_center_configuration, params) req.send_request() end |
#create_lake_formation_opt_in(params = {}) ⇒ Struct
Enforce Lake Formation permissions for the given databases, tables, and principals.
1104 1105 1106 1107 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1104 def create_lake_formation_opt_in(params = {}, = {}) req = build_request(:create_lake_formation_opt_in, params) req.send_request() end |
#create_lf_tag(params = {}) ⇒ Struct
Creates an LF-tag with the specified name and values.
961 962 963 964 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 961 def create_lf_tag(params = {}, = {}) req = build_request(:create_lf_tag, params) req.send_request() end |
#delete_data_cells_filter(params = {}) ⇒ Struct
Deletes a data cell filter.
1138 1139 1140 1141 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1138 def delete_data_cells_filter(params = {}, = {}) req = build_request(:delete_data_cells_filter, params) req.send_request() end |
#delete_lake_formation_identity_center_configuration(params = {}) ⇒ Struct
Deletes an IAM Identity Center connection with Lake Formation.
1197 1198 1199 1200 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1197 def delete_lake_formation_identity_center_configuration(params = {}, = {}) req = build_request(:delete_lake_formation_identity_center_configuration, params) req.send_request() end |
#delete_lake_formation_opt_in(params = {}) ⇒ Struct
Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
1275 1276 1277 1278 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1275 def delete_lake_formation_opt_in(params = {}, = {}) req = build_request(:delete_lake_formation_opt_in, params) req.send_request() end |
#delete_lf_tag(params = {}) ⇒ Struct
Deletes the specified LF-tag given a key name. If the input parameter
tag key was not found, then the operation will throw an exception.
When you delete an LF-tag, the LFTagPolicy
attached to the LF-tag
becomes invalid. If the deleted LF-tag was still assigned to any
resource, the tag policy attach to the deleted LF-tag will no longer
be applied to the resource.
1172 1173 1174 1175 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1172 def delete_lf_tag(params = {}, = {}) req = build_request(:delete_lf_tag, params) req.send_request() end |
#delete_objects_on_cancel(params = {}) ⇒ Struct
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. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels.
The Glue ETL library function write_dynamic_frame.from_catalog()
includes an option to automatically call DeleteObjectsOnCancel
before writes. For more information, see Rolling Back Amazon S3
Writes.
1333 1334 1335 1336 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1333 def delete_objects_on_cancel(params = {}, = {}) req = build_request(:delete_objects_on_cancel, params) req.send_request() end |
#deregister_resource(params = {}) ⇒ Struct
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.
1359 1360 1361 1362 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1359 def deregister_resource(params = {}, = {}) req = build_request(:deregister_resource, params) req.send_request() end |
#describe_lake_formation_identity_center_configuration(params = {}) ⇒ Types::DescribeLakeFormationIdentityCenterConfigurationResponse
Retrieves the instance ARN and application ARN for the connection.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1403 def describe_lake_formation_identity_center_configuration(params = {}, = {}) req = build_request(:describe_lake_formation_identity_center_configuration, params) req.send_request() end |
#describe_resource(params = {}) ⇒ Types::DescribeResourceResponse
Retrieves the current data access role for the given resource registered in Lake Formation.
1436 1437 1438 1439 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1436 def describe_resource(params = {}, = {}) req = build_request(:describe_resource, params) req.send_request() end |
#describe_transaction(params = {}) ⇒ Types::DescribeTransactionResponse
Returns the details of a single transaction.
1467 1468 1469 1470 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1467 def describe_transaction(params = {}, = {}) req = build_request(:describe_transaction, params) req.send_request() end |
#extend_transaction(params = {}) ⇒ Struct
Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.
1493 1494 1495 1496 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1493 def extend_transaction(params = {}, = {}) req = build_request(:extend_transaction, params) req.send_request() end |
#get_data_cells_filter(params = {}) ⇒ Types::GetDataCellsFilterResponse
Returns a data cells filter.
1542 1543 1544 1545 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1542 def get_data_cells_filter(params = {}, = {}) req = build_request(:get_data_cells_filter, params) req.send_request() end |
#get_data_lake_settings(params = {}) ⇒ Types::GetDataLakeSettingsResponse
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1595 def get_data_lake_settings(params = {}, = {}) req = build_request(:get_data_lake_settings, params) req.send_request() end |
#get_effective_permissions_for_path(params = {}) ⇒ Types::GetEffectivePermissionsForPathResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1684 1685 1686 1687 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1684 def (params = {}, = {}) req = build_request(:get_effective_permissions_for_path, params) req.send_request() end |
#get_lf_tag(params = {}) ⇒ Types::GetLFTagResponse
Returns an LF-tag definition.
1724 1725 1726 1727 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1724 def get_lf_tag(params = {}, = {}) req = build_request(:get_lf_tag, params) req.send_request() end |
#get_query_state(params = {}) ⇒ Types::GetQueryStateResponse
Returns the state of a query previously submitted. Clients are
expected to poll GetQueryState
to monitor the current state of the
planning before retrieving the work units. A query state is only
visible to the principal that made the initial call to
StartQueryPlanning
.
1758 1759 1760 1761 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1758 def get_query_state(params = {}, = {}) req = build_request(:get_query_state, params) req.send_request() end |
#get_query_statistics(params = {}) ⇒ Types::GetQueryStatisticsResponse
Retrieves statistics on the planning and execution of a query.
1795 1796 1797 1798 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1795 def get_query_statistics(params = {}, = {}) req = build_request(:get_query_statistics, params) req.send_request() end |
#get_resource_lf_tags(params = {}) ⇒ Types::GetResourceLFTagsResponse
Returns the LF-tags applied to a resource.
1901 1902 1903 1904 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1901 def (params = {}, = {}) req = build_request(:get_resource_lf_tags, params) req.send_request() end |
#get_table_objects(params = {}) ⇒ Types::GetTableObjectsResponse
Returns the set of Amazon S3 objects that make up the specified governed table. A transaction ID or timestamp can be specified for time-travel queries.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1985 1986 1987 1988 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1985 def get_table_objects(params = {}, = {}) req = build_request(:get_table_objects, params) req.send_request() end |
#get_temporary_glue_partition_credentials(params = {}) ⇒ Types::GetTemporaryGluePartitionCredentialsResponse
This API is identical to GetTemporaryTableCredentials
except that
this is used when the target Data Catalog resource is of type
Partition. Lake Formation restricts the permission of the vended
credentials with the same scope down policy which restricts access to
a single Amazon S3 prefix.
2051 2052 2053 2054 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2051 def get_temporary_glue_partition_credentials(params = {}, = {}) req = build_request(:get_temporary_glue_partition_credentials, params) req.send_request() end |
#get_temporary_glue_table_credentials(params = {}) ⇒ Types::GetTemporaryGlueTableCredentialsResponse
Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
2134 2135 2136 2137 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2134 def get_temporary_glue_table_credentials(params = {}, = {}) req = build_request(:get_temporary_glue_table_credentials, params) req.send_request() end |
#get_work_unit_results(params = {}) ⇒ Types::GetWorkUnitResultsResponse
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
2174 2175 2176 2177 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2174 def get_work_unit_results(params = {}, = {}, &block) req = build_request(:get_work_unit_results, params) req.send_request(, &block) end |
#get_work_units(params = {}) ⇒ Types::GetWorkUnitsResponse
Retrieves the work units generated by the StartQueryPlanning
operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2225 2226 2227 2228 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2225 def get_work_units(params = {}, = {}) req = build_request(:get_work_units, params) req.send_request() end |
#grant_permissions(params = {}) ⇒ Struct
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.
2338 2339 2340 2341 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2338 def (params = {}, = {}) req = build_request(:grant_permissions, params) req.send_request() end |
#list_data_cells_filter(params = {}) ⇒ Types::ListDataCellsFilterResponse
Lists all the data cell filters on a table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2394 2395 2396 2397 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2394 def list_data_cells_filter(params = {}, = {}) req = build_request(:list_data_cells_filter, params) req.send_request() end |
#list_lake_formation_opt_ins(params = {}) ⇒ Types::ListLakeFormationOptInsResponse
Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2578 2579 2580 2581 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2578 def list_lake_formation_opt_ins(params = {}, = {}) req = build_request(:list_lake_formation_opt_ins, params) req.send_request() end |
#list_lf_tags(params = {}) ⇒ Types::ListLFTagsResponse
Lists LF-tags that the requester has permission to view.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2450 2451 2452 2453 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2450 def (params = {}, = {}) req = build_request(:list_lf_tags, params) req.send_request() end |
#list_permissions(params = {}) ⇒ Types::ListPermissionsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2742 2743 2744 2745 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2742 def (params = {}, = {}) req = build_request(:list_permissions, params) req.send_request() end |
#list_resources(params = {}) ⇒ Types::ListResourcesResponse
Lists the resources registered to be managed by the Data Catalog.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2795 2796 2797 2798 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2795 def list_resources(params = {}, = {}) req = build_request(:list_resources, params) req.send_request() end |
#list_table_storage_optimizers(params = {}) ⇒ Types::ListTableStorageOptimizersResponse
Returns the configuration of all storage optimizers associated with a specified table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2855 2856 2857 2858 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2855 def list_table_storage_optimizers(params = {}, = {}) req = build_request(:list_table_storage_optimizers, params) req.send_request() end |
#list_transactions(params = {}) ⇒ Types::ListTransactionsResponse
Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.
This operation can help you identify uncommitted transactions or to get information about transactions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2912 2913 2914 2915 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2912 def list_transactions(params = {}, = {}) req = build_request(:list_transactions, params) req.send_request() end |
#put_data_lake_settings(params = {}) ⇒ Struct
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.
2991 2992 2993 2994 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2991 def put_data_lake_settings(params = {}, = {}) req = build_request(:put_data_lake_settings, params) req.send_request() end |
#register_resource(params = {}) ⇒ Struct
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 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
3062 3063 3064 3065 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3062 def register_resource(params = {}, = {}) req = build_request(:register_resource, params) req.send_request() end |
#remove_lf_tags_from_resource(params = {}) ⇒ Types::RemoveLFTagsFromResourceResponse
Removes an LF-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.
3164 3165 3166 3167 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3164 def (params = {}, = {}) req = build_request(:remove_lf_tags_from_resource, params) req.send_request() end |
#revoke_permissions(params = {}) ⇒ Struct
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
3264 3265 3266 3267 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3264 def (params = {}, = {}) req = build_request(:revoke_permissions, params) req.send_request() end |
#search_databases_by_lf_tags(params = {}) ⇒ Types::SearchDatabasesByLFTagsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3330 3331 3332 3333 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3330 def (params = {}, = {}) req = build_request(:search_databases_by_lf_tags, params) req.send_request() end |
#search_tables_by_lf_tags(params = {}) ⇒ Types::SearchTablesByLFTagsResponse
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
LF-tags. 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3408 3409 3410 3411 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3408 def (params = {}, = {}) req = build_request(:search_tables_by_lf_tags, params) req.send_request() end |
#start_query_planning(params = {}) ⇒ Types::StartQueryPlanningResponse
Submits a request to process a query statement.
This operation generates work units that can be retrieved with the
GetWorkUnits
operation as soon as the query state is
WORKUNITS_AVAILABLE or FINISHED.
3452 3453 3454 3455 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3452 def start_query_planning(params = {}, = {}) req = build_request(:start_query_planning, params) req.send_request() end |
#start_transaction(params = {}) ⇒ Types::StartTransactionResponse
Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
3483 3484 3485 3486 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3483 def start_transaction(params = {}, = {}) req = build_request(:start_transaction, params) req.send_request() end |
#update_data_cells_filter(params = {}) ⇒ Struct
Updates a data cell filter.
3521 3522 3523 3524 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3521 def update_data_cells_filter(params = {}, = {}) req = build_request(:update_data_cells_filter, params) req.send_request() end |
#update_lake_formation_identity_center_configuration(params = {}) ⇒ Struct
Updates the IAM Identity Center connection parameters.
3623 3624 3625 3626 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3623 def update_lake_formation_identity_center_configuration(params = {}, = {}) req = build_request(:update_lake_formation_identity_center_configuration, params) req.send_request() end |
#update_lf_tag(params = {}) ⇒ Struct
Updates the list of possible values for the specified LF-tag key. If the LF-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 LF-tag key's value.
3564 3565 3566 3567 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3564 def update_lf_tag(params = {}, = {}) req = build_request(:update_lf_tag, params) req.send_request() end |
#update_resource(params = {}) ⇒ Struct
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
3661 3662 3663 3664 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3661 def update_resource(params = {}, = {}) req = build_request(:update_resource, params) req.send_request() end |
#update_table_objects(params = {}) ⇒ Struct
Updates the manifest of Amazon S3 objects that make up the specified governed table.
3716 3717 3718 3719 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3716 def update_table_objects(params = {}, = {}) req = build_request(:update_table_objects, params) req.send_request() end |
#update_table_storage_optimizer(params = {}) ⇒ Types::UpdateTableStorageOptimizerResponse
Updates the configuration of the storage optimizers for a table.
3760 3761 3762 3763 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3760 def update_table_storage_optimizer(params = {}, = {}) req = build_request(:update_table_storage_optimizer, params) req.send_request() end |