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.
-
#attach_rls_policy(params = {}) ⇒ Struct
Attaches a row-level security policy to a resource for a principal.
-
#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.
-
#create_lf_tag_expression(params = {}) ⇒ Struct
Creates a new LF-Tag expression with the provided name, description, catalog ID, and expression body.
-
#create_rls_policy(params = {}) ⇒ Struct
Creates a row-level security (RLS) policy.
-
#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 an LF-tag by its key name.
-
#delete_lf_tag_expression(params = {}) ⇒ Struct
Deletes the LF-Tag expression.
-
#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.
-
#delete_rls_policy(params = {}) ⇒ Struct
Deletes a row-level security policy.
-
#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.
-
#detach_rls_policy(params = {}) ⇒ Struct
Detaches a row-level security policy from a resource for a principal.
-
#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_glue_function_session_context(params = {}) ⇒ Types::GetGlueFunctionSessionContextResponse
Returns a session context for one or more user-defined functions that an integrated analytics engine runs together in a job.
-
#get_lf_tag(params = {}) ⇒ Types::GetLFTagResponse
Returns an LF-tag definition.
-
#get_lf_tag_expression(params = {}) ⇒ Types::GetLFTagExpressionResponse
Returns the details about the LF-Tag expression.
-
#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_rls_policy(params = {}) ⇒ Types::GetRLSPolicyResponse
Returns the definition of a row-level security policy, including its attachment columns and filter expression.
-
#get_table_objects(params = {}) ⇒ Types::GetTableObjectsResponse
Returns the set of Amazon S3 objects that make up the specified governed table.
-
#get_temporary_data_location_credentials(params = {}) ⇒ Types::GetTemporaryDataLocationCredentialsResponse
Allows a user or application in a secure environment to access data in a specific Amazon S3 location registered with Lake Formation by providing temporary scoped credentials that are limited to the requested data location and the caller's authorized access level.
-
#get_temporary_glue_function_credentials(params = {}) ⇒ Types::GetTemporaryGlueFunctionCredentialsResponse
Returns temporary credentials that you can use to download the artifacts of a user-defined function whose
GovernanceModeisLAKE_FORMATION. -
#get_temporary_glue_partition_credentials(params = {}) ⇒ Types::GetTemporaryGluePartitionCredentialsResponse
This API is identical to
GetTemporaryTableCredentialsexcept 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
StartQueryPlanningoperation. -
#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_tag_expressions(params = {}) ⇒ Types::ListLFTagExpressionsResponse
Returns the LF-Tag expressions in caller’s account filtered based on caller's 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_rls_policies(params = {}) ⇒ Types::ListRLSPoliciesResponse
Lists the row-level security policies in the Data Catalog.
-
#list_rls_policy_attachments(params = {}) ⇒ Types::ListRLSPolicyAttachmentsResponse
Lists the row-level security policy attachments in 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
DATABASEresources byTagCondition. -
#search_tables_by_lf_tags(params = {}) ⇒ Types::SearchTablesByLFTagsResponse
This operation allows a search on
TABLEresources byLFTags. -
#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_lf_tag_expression(params = {}) ⇒ Struct
Updates the name of the LF-Tag expression to the new description and expression body provided.
-
#update_resource(params = {}) ⇒ Struct
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
-
#update_rls_policy(params = {}) ⇒ Struct
Updates the filter expression of an existing row-level security policy.
-
#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.
479 480 481 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 479 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.
600 601 602 603 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 600 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 include the following actions:
glue:Database
glue:Table
glue:Partition
glue:UserDefinedFunction
lakeformation:GetDataAccess
677 678 679 680 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 677 def assume_decorated_role_with_saml(params = {}, = {}) req = build_request(:assume_decorated_role_with_saml, params) req.send_request() end |
#attach_rls_policy(params = {}) ⇒ Struct
Attaches a row-level security policy to a resource for a principal. When the principal queries the resource, Lake Formation applies the policy's filter expression so that only the permitted rows are returned.
794 795 796 797 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 794 def attach_rls_policy(params = {}, = {}) req = build_request(:attach_rls_policy, params) req.send_request() end |
#batch_grant_permissions(params = {}) ⇒ Types::BatchGrantPermissionsResponse
Batch operation to grant permissions to the principal.
960 961 962 963 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 960 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.
1126 1127 1128 1129 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1126 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.
1149 1150 1151 1152 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1149 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.
1179 1180 1181 1182 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1179 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.
1218 1219 1220 1221 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1218 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.
1382 1383 1384 1385 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1382 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.
1488 1489 1490 1491 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1488 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.
1251 1252 1253 1254 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1251 def create_lf_tag(params = {}, = {}) req = build_request(:create_lf_tag, params) req.send_request() end |
#create_lf_tag_expression(params = {}) ⇒ Struct
Creates a new LF-Tag expression with the provided name, description, catalog ID, and expression body. This call fails if a LF-Tag expression with the same name already exists in the caller’s account or if the underlying LF-Tags don't exist. To call this API operation, caller needs the following Lake Formation permissions:
CREATE_LF_TAG_EXPRESSION on the root catalog resource.
GRANT_WITH_LF_TAG_EXPRESSION on all underlying LF-Tag key:value
pairs included in the expression.
1302 1303 1304 1305 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1302 def create_lf_tag_expression(params = {}, = {}) req = build_request(:create_lf_tag_expression, params) req.send_request() end |
#create_rls_policy(params = {}) ⇒ Struct
Creates a row-level security (RLS) policy. A row-level security policy
defines a filter expression that Lake Formation evaluates to determine
which rows of a table a principal is allowed to see. The policy is
created independently of any resource, and is later associated with a
resource and principal using AttachRLSPolicy.
1532 1533 1534 1535 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1532 def create_rls_policy(params = {}, = {}) req = build_request(:create_rls_policy, params) req.send_request() end |
#delete_data_cells_filter(params = {}) ⇒ Struct
Deletes a data cell filter.
1566 1567 1568 1569 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1566 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.
1656 1657 1658 1659 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1656 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.
1762 1763 1764 1765 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1762 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 an LF-tag by its key name. The operation fails if the specified tag key doesn't exist. When you delete an LF-Tag:
The associated LF-Tag policy becomes invalid.
Resources that had this tag assigned will no longer have the tag policy applied to them.
1601 1602 1603 1604 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1601 def delete_lf_tag(params = {}, = {}) req = build_request(:delete_lf_tag, params) req.send_request() end |
#delete_lf_tag_expression(params = {}) ⇒ Struct
Deletes the LF-Tag expression. The caller must be a data lake admin or
have DROP permissions on the LF-Tag expression. Deleting a LF-Tag
expression will also delete all LFTagPolicy permissions referencing
the LF-Tag expression.
1631 1632 1633 1634 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1631 def delete_lf_tag_expression(params = {}, = {}) req = build_request(:delete_lf_tag_expression, 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.
1820 1821 1822 1823 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1820 def delete_objects_on_cancel(params = {}, = {}) req = build_request(:delete_objects_on_cancel, params) req.send_request() end |
#delete_rls_policy(params = {}) ⇒ Struct
Deletes a row-level security policy. Any active attachments of the policy are automatically removed as part of the deletion, so you do not need to detach the policy first.
1844 1845 1846 1847 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1844 def delete_rls_policy(params = {}, = {}) req = build_request(:delete_rls_policy, 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.
1870 1871 1872 1873 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1870 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.
1918 1919 1920 1921 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1918 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.
1954 1955 1956 1957 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1954 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.
1985 1986 1987 1988 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1985 def describe_transaction(params = {}, = {}) req = build_request(:describe_transaction, params) req.send_request() end |
#detach_rls_policy(params = {}) ⇒ Struct
Detaches a row-level security policy from a resource for a principal. After the policy is detached, its filter expression is no longer applied to the principal's queries on that resource.
2100 2101 2102 2103 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2100 def detach_rls_policy(params = {}, = {}) req = build_request(:detach_rls_policy, 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.
2126 2127 2128 2129 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2126 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.
2175 2176 2177 2178 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2175 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.
2194 2195 2196 2197 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2194 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.
2247 2248 2249 2250 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2247 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.
2348 2349 2350 2351 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2348 def (params = {}, = {}) req = build_request(:get_effective_permissions_for_path, params) req.send_request() end |
#get_glue_function_session_context(params = {}) ⇒ Types::GetGlueFunctionSessionContextResponse
Returns a session context for one or more user-defined functions that
an integrated analytics engine runs together in a job. You must have
the EXECUTE permission on every function in the list.
While the session context is in use, if you don't have full SELECT
permission on a table, the job can read the table only if every
function in the session has the SELECT permission on it. Lake
Formation enforces this check.
To use this operation, you must have the lakeformation:GetDataAccess
permission.
2396 2397 2398 2399 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2396 def get_glue_function_session_context(params = {}, = {}) req = build_request(:get_glue_function_session_context, params) req.send_request() end |
#get_lf_tag(params = {}) ⇒ Types::GetLFTagResponse
Returns an LF-tag definition.
2436 2437 2438 2439 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2436 def get_lf_tag(params = {}, = {}) req = build_request(:get_lf_tag, params) req.send_request() end |
#get_lf_tag_expression(params = {}) ⇒ Types::GetLFTagExpressionResponse
Returns the details about the LF-Tag expression. The caller must be a
data lake admin or must have DESCRIBE permission on the LF-Tag
expression resource.
2479 2480 2481 2482 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2479 def get_lf_tag_expression(params = {}, = {}) req = build_request(:get_lf_tag_expression, 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.
2513 2514 2515 2516 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2513 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.
2550 2551 2552 2553 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2550 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.
2711 2712 2713 2714 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2711 def (params = {}, = {}) req = build_request(:get_resource_lf_tags, params) req.send_request() end |
#get_rls_policy(params = {}) ⇒ Types::GetRLSPolicyResponse
Returns the definition of a row-level security policy, including its attachment columns and filter expression.
2584 2585 2586 2587 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2584 def get_rls_policy(params = {}, = {}) req = build_request(:get_rls_policy, 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.
2795 2796 2797 2798 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2795 def get_table_objects(params = {}, = {}) req = build_request(:get_table_objects, params) req.send_request() end |
#get_temporary_data_location_credentials(params = {}) ⇒ Types::GetTemporaryDataLocationCredentialsResponse
Allows a user or application in a secure environment to access data in a specific Amazon S3 location registered with Lake Formation by providing temporary scoped credentials that are limited to the requested data location and the caller's authorized access level.
GetDataAccess is logged in CloudTrail whenever a principal requests
temporary data location credentials to access data in a data lake
location that is registered with Lake Formation.
The API operation returns an error in the following scenarios:
The data location is not registered with Lake Formation.
No Glue table is associated with the data location.
The caller doesn't have required permissions on the associated table. The caller must have
SELECTorSUPERpermissions on the associated table, and credential vending for full table access must be enabled in the data lake settings.For more information, see Application integration for full table access.
The data location is in a different Amazon Web Services Region. Lake Formation doesn't support cross-Region access when vending credentials for a data location. Lake Formation only supports Amazon S3 paths registered within the same Region as the API call.
2883 2884 2885 2886 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2883 def get_temporary_data_location_credentials(params = {}, = {}) req = build_request(:get_temporary_data_location_credentials, params) req.send_request() end |
#get_temporary_glue_function_credentials(params = {}) ⇒ Types::GetTemporaryGlueFunctionCredentialsResponse
Returns temporary credentials that you can use to download the
artifacts of a user-defined function whose GovernanceMode is
LAKE_FORMATION. Lake Formation assumes the role that you registered
for the function's ArtifactLocation. The credentials have read-only
access to that location in Amazon S3.
To use this operation, you must have the EXECUTE permission on the
function.
2934 2935 2936 2937 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 2934 def get_temporary_glue_function_credentials(params = {}, = {}) req = build_request(:get_temporary_glue_function_credentials, 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.
3000 3001 3002 3003 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3000 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.
To call this API, the role that the service assumes must have
lakeformation:GetDataAccess permission on the resource.
3086 3087 3088 3089 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3086 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.
3126 3127 3128 3129 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3126 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.
3177 3178 3179 3180 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3177 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.
3318 3319 3320 3321 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3318 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.
3374 3375 3376 3377 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3374 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.
3642 3643 3644 3645 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3642 def list_lake_formation_opt_ins(params = {}, = {}) req = build_request(:list_lake_formation_opt_ins, params) req.send_request() end |
#list_lf_tag_expressions(params = {}) ⇒ Types::ListLFTagExpressionsResponse
Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions. Data Lake and read only admins implicitly can see all tag expressions in their account, else caller needs DESCRIBE permissions on tag expression.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3425 3426 3427 3428 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3425 def list_lf_tag_expressions(params = {}, = {}) req = build_request(:list_lf_tag_expressions, 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.
3481 3482 3483 3484 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3481 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. If both Principal and Resource parameters are
provided, the response returns effective permissions rather than the
explicitly granted permissions.
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.
3846 3847 3848 3849 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3846 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.
4110 4111 4112 4113 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4110 def list_resources(params = {}, = {}) req = build_request(:list_resources, params) req.send_request() end |
#list_rls_policies(params = {}) ⇒ Types::ListRLSPoliciesResponse
Lists the row-level security policies in the Data Catalog.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3889 3890 3891 3892 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 3889 def list_rls_policies(params = {}, = {}) req = build_request(:list_rls_policies, params) req.send_request() end |
#list_rls_policy_attachments(params = {}) ⇒ Types::ListRLSPolicyAttachmentsResponse
Lists the row-level security policy attachments in the Data Catalog. You can filter the results by resource, principal, or policy name.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4054 4055 4056 4057 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4054 def (params = {}, = {}) req = build_request(:list_rls_policy_attachments, 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.
4170 4171 4172 4173 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4170 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.
4227 4228 4229 4230 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4227 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.
4306 4307 4308 4309 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4306 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 data location. 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
4387 4388 4389 4390 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4387 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.
4510 4511 4512 4513 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4510 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.
4638 4639 4640 4641 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4638 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.
4704 4705 4706 4707 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4704 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 LFTags. 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 LFTags
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.
4782 4783 4784 4785 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4782 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.
4826 4827 4828 4829 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4826 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.
4857 4858 4859 4860 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4857 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.
4895 4896 4897 4898 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4895 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.
5055 5056 5057 5058 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 5055 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.
4938 4939 4940 4941 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4938 def update_lf_tag(params = {}, = {}) req = build_request(:update_lf_tag, params) req.send_request() end |
#update_lf_tag_expression(params = {}) ⇒ Struct
Updates the name of the LF-Tag expression to the new description and
expression body provided. Updating a LF-Tag expression immediately
changes the permission boundaries of all existing LFTagPolicy
permission grants that reference the given LF-Tag expression.
4981 4982 4983 4984 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 4981 def update_lf_tag_expression(params = {}, = {}) req = build_request(:update_lf_tag_expression, 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.
5126 5127 5128 5129 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 5126 def update_resource(params = {}, = {}) req = build_request(:update_resource, params) req.send_request() end |
#update_rls_policy(params = {}) ⇒ Struct
Updates the filter expression of an existing row-level security policy. The change applies to all attachments of the policy.
5083 5084 5085 5086 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 5083 def update_rls_policy(params = {}, = {}) req = build_request(:update_rls_policy, params) req.send_request() end |
#update_table_objects(params = {}) ⇒ Struct
Updates the manifest of Amazon S3 objects that make up the specified governed table.
5181 5182 5183 5184 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 5181 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.
5225 5226 5227 5228 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 5225 def update_table_storage_optimizer(params = {}, = {}) req = build_request(:update_table_storage_optimizer, params) req.send_request() end |