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_principal(params = {}) ⇒ Types::GetDataLakePrincipalResponse
Returns the identity of the invoking principal.
-
#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.
410 411 412 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 410 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.
510 511 512 513 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 510 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:
577 578 579 580 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 577 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.
707 708 709 710 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 707 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.
837 838 839 840 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 837 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.
860 861 862 863 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 860 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.
890 891 892 893 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 890 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.
929 930 931 932 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 929 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.
1027 1028 1029 1030 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1027 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.
1105 1106 1107 1108 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1105 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.
962 963 964 965 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 962 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.
1139 1140 1141 1142 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1139 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.
1198 1199 1200 1201 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1198 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.
1276 1277 1278 1279 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1276 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.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1173 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.
1334 1335 1336 1337 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1334 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.
1360 1361 1362 1363 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1360 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.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1404 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.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1437 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.
1468 1469 1470 1471 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1468 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.
1494 1495 1496 1497 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1494 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.
1543 1544 1545 1546 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1543 def get_data_cells_filter(params = {}, = {}) req = build_request(:get_data_cells_filter, params) req.send_request() end |
#get_data_lake_principal(params = {}) ⇒ Types::GetDataLakePrincipalResponse
Returns the identity of the invoking principal.
1562 1563 1564 1565 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1562 def get_data_lake_principal(params = {}, = {}) req = build_request(:get_data_lake_principal, 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.
1615 1616 1617 1618 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1615 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.
1704 1705 1706 1707 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1704 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.
1744 1745 1746 1747 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1744 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
.
1778 1779 1780 1781 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1778 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.
1815 1816 1817 1818 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1815 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.
1921 1922 1923 1924 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1921 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.
2005 2006 2007 2008 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2005 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.
2071 2072 2073 2074 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2071 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.
2154 2155 2156 2157 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2154 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.
2194 2195 2196 2197 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2194 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.
2245 2246 2247 2248 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2245 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.
2358 2359 2360 2361 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2358 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.
2414 2415 2416 2417 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2414 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.
2598 2599 2600 2601 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2598 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.
2470 2471 2472 2473 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2470 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.
2762 2763 2764 2765 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2762 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.
2815 2816 2817 2818 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2815 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.
2875 2876 2877 2878 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2875 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.
2932 2933 2934 2935 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2932 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.
3011 3012 3013 3014 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3011 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
3082 3083 3084 3085 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3082 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.
3184 3185 3186 3187 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3184 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.
3284 3285 3286 3287 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3284 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.
3350 3351 3352 3353 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3350 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.
3428 3429 3430 3431 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3428 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.
3472 3473 3474 3475 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3472 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.
3503 3504 3505 3506 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3503 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.
3541 3542 3543 3544 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3541 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.
3643 3644 3645 3646 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3643 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.
3584 3585 3586 3587 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3584 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.
3681 3682 3683 3684 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3681 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.
3736 3737 3738 3739 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3736 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.
3780 3781 3782 3783 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3780 def update_table_storage_optimizer(params = {}, = {}) req = build_request(:update_table_storage_optimizer, params) req.send_request() end |