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
-
#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.
-
#deregister_resource(params = {}) ⇒ Struct
Deregisters the resource as managed by the Data Catalog.
-
#describe_resource(params = {}) ⇒ Types::DescribeResourceResponse
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
-
#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.
-
#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_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.
-
#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.
-
#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.
-
#update_resource(params = {}) ⇒ Struct
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
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.
334 335 336 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#batch_grant_permissions(params = {}) ⇒ Types::BatchGrantPermissionsResponse
Batch operation to grant permissions to the principal.
430 431 432 433 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 430 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.
525 526 527 528 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 525 def (params = {}, = {}) req = build_request(:batch_revoke_permissions, 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.
551 552 553 554 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 551 def deregister_resource(params = {}, = {}) req = build_request(:deregister_resource, params) req.send_request() end |
#describe_resource(params = {}) ⇒ Types::DescribeResourceResponse
Retrieves the current data access role for the given resource registered in AWS Lake Formation.
582 583 584 585 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 582 def describe_resource(params = {}, = {}) req = build_request(:describe_resource, 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.
625 626 627 628 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 625 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.
698 699 700 701 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 698 def (params = {}, = {}) req = build_request(:get_effective_permissions_for_path, 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.
790 791 792 793 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 790 def (params = {}, = {}) req = build_request(:grant_permissions, 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.
913 914 915 916 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 913 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.
964 965 966 967 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 964 def list_resources(params = {}, = {}) req = build_request(:list_resources, 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.
1027 1028 1029 1030 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1027 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 AWS 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
1088 1089 1090 1091 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1088 def register_resource(params = {}, = {}) req = build_request(:register_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.
1167 1168 1169 1170 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1167 def (params = {}, = {}) req = build_request(:revoke_permissions, params) req.send_request() end |
#update_resource(params = {}) ⇒ Struct
Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.
1195 1196 1197 1198 |
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/client.rb', line 1195 def update_resource(params = {}, = {}) req = build_request(:update_resource, params) req.send_request() end |