/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::LakeFormation

NAME

Paws::LakeFormation - Perl Interface to AWS AWS Lake Formation

SYNOPSIS

use Paws;

my $obj = Paws->service('LakeFormation');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

AWS Lake Formation

Defines the public endpoint for the AWS Lake Formation service.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31

METHODS

AddLFTagsToResource

LFTags => ArrayRef[Paws::LakeFormation::LFTagPair]
Resource => Paws::LakeFormation::Resource
[CatalogId => Str]

Each argument is described in detail in: Paws::LakeFormation::AddLFTagsToResource

Returns: a Paws::LakeFormation::AddLFTagsToResourceResponse instance

Attaches one or more tags to an existing resource.

BatchGrantPermissions

Entries => ArrayRef[Paws::LakeFormation::BatchPermissionsRequestEntry]
[CatalogId => Str]

Each argument is described in detail in: Paws::LakeFormation::BatchGrantPermissions

Returns: a Paws::LakeFormation::BatchGrantPermissionsResponse instance

Batch operation to grant permissions to the principal.

BatchRevokePermissions

Entries => ArrayRef[Paws::LakeFormation::BatchPermissionsRequestEntry]
[CatalogId => Str]

Each argument is described in detail in: Paws::LakeFormation::BatchRevokePermissions

Returns: a Paws::LakeFormation::BatchRevokePermissionsResponse instance

Batch operation to revoke permissions from the principal.

CreateLFTag

TagKey => Str
TagValues => ArrayRef[Str|Undef]
[CatalogId => Str]

Each argument is described in detail in: Paws::LakeFormation::CreateLFTag

Returns: a Paws::LakeFormation::CreateLFTagResponse instance

Creates a tag with the specified name and values.

DeleteLFTag

TagKey => Str
[CatalogId => Str]

Each argument is described in detail in: Paws::LakeFormation::DeleteLFTag

Returns: a Paws::LakeFormation::DeleteLFTagResponse instance

Deletes the specified tag key name. If the attribute key does not exist or the tag does not exist, then the operation will not do anything. If the attribute key exists, then the operation checks if any resources are tagged with this attribute key, if yes, the API throws a 400 Exception with the message "Delete not allowed" as the tag key is still attached with resources. You can consider untagging resources with this tag key.

DeregisterResource

ResourceArn => Str

Each argument is described in detail in: Paws::LakeFormation::DeregisterResource

Returns: a Paws::LakeFormation::DeregisterResourceResponse instance

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.

DescribeResource

ResourceArn => Str

Each argument is described in detail in: Paws::LakeFormation::DescribeResource

Returns: a Paws::LakeFormation::DescribeResourceResponse instance

Retrieves the current data access role for the given resource registered in AWS Lake Formation.

GetDataLakeSettings

[CatalogId => Str]

Each argument is described in detail in: Paws::LakeFormation::GetDataLakeSettings

Returns: a Paws::LakeFormation::GetDataLakeSettingsResponse instance

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

GetEffectivePermissionsForPath

ResourceArn => Str
[CatalogId => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LakeFormation::GetEffectivePermissionsForPath

Returns: a Paws::LakeFormation::GetEffectivePermissionsForPathResponse instance

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.

GetLFTag

TagKey => Str
[CatalogId => Str]

Each argument is described in detail in: Paws::LakeFormation::GetLFTag

Returns: a Paws::LakeFormation::GetLFTagResponse instance

Returns a tag definition.

GetResourceLFTags

Resource => Paws::LakeFormation::Resource
[CatalogId => Str]
[ShowAssignedLFTags => Bool]

Each argument is described in detail in: Paws::LakeFormation::GetResourceLFTags

Returns: a Paws::LakeFormation::GetResourceLFTagsResponse instance

Returns the tags applied to a resource.

GrantPermissions

Permissions => ArrayRef[Str|Undef]
Principal => Paws::LakeFormation::DataLakePrincipal
Resource => Paws::LakeFormation::Resource
[CatalogId => Str]
[PermissionsWithGrantOption => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::LakeFormation::GrantPermissions

Returns: a Paws::LakeFormation::GrantPermissionsResponse instance

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 (https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html).

ListLFTags

[CatalogId => Str]
[MaxResults => Int]
[NextToken => Str]
[ResourceShareType => Str]

Each argument is described in detail in: Paws::LakeFormation::ListLFTags

Returns: a Paws::LakeFormation::ListLFTagsResponse instance

Lists tags that the requester has permission to view.

ListPermissions

[CatalogId => Str]
[MaxResults => Int]
[NextToken => Str]
[Principal => Paws::LakeFormation::DataLakePrincipal]
[Resource => Paws::LakeFormation::Resource]
[ResourceType => Str]

Each argument is described in detail in: Paws::LakeFormation::ListPermissions

Returns: a Paws::LakeFormation::ListPermissionsResponse instance

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 (https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html).

ListResources

[FilterConditionList => ArrayRef[Paws::LakeFormation::FilterCondition]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LakeFormation::ListResources

Returns: a Paws::LakeFormation::ListResourcesResponse instance

Lists the resources registered to be managed by the Data Catalog.

PutDataLakeSettings

DataLakeSettings => Paws::LakeFormation::DataLakeSettings
[CatalogId => Str]

Each argument is described in detail in: Paws::LakeFormation::PutDataLakeSettings

Returns: a Paws::LakeFormation::PutDataLakeSettingsResponse instance

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 (https://docs.aws.amazon.com/lake-formation/latest/dg/lake-formation-permissions.html).

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.

RegisterResource

ResourceArn => Str
[RoleArn => Str]
[UseServiceLinkedRole => Bool]

Each argument is described in detail in: Paws::LakeFormation::RegisterResource

Returns: a Paws::LakeFormation::RegisterResourceResponse instance

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

RemoveLFTagsFromResource

LFTags => ArrayRef[Paws::LakeFormation::LFTagPair]
Resource => Paws::LakeFormation::Resource
[CatalogId => Str]

Each argument is described in detail in: Paws::LakeFormation::RemoveLFTagsFromResource

Returns: a Paws::LakeFormation::RemoveLFTagsFromResourceResponse instance

Removes a 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.

RevokePermissions

Permissions => ArrayRef[Str|Undef]
Principal => Paws::LakeFormation::DataLakePrincipal
Resource => Paws::LakeFormation::Resource
[CatalogId => Str]
[PermissionsWithGrantOption => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::LakeFormation::RevokePermissions

Returns: a Paws::LakeFormation::RevokePermissionsResponse instance

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

SearchDatabasesByLFTags

Expression => ArrayRef[Paws::LakeFormation::LFTag]
[CatalogId => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LakeFormation::SearchDatabasesByLFTags

Returns: a Paws::LakeFormation::SearchDatabasesByLFTagsResponse instance

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.

SearchTablesByLFTags

Expression => ArrayRef[Paws::LakeFormation::LFTag]
[CatalogId => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LakeFormation::SearchTablesByLFTags

Returns: a Paws::LakeFormation::SearchTablesByLFTagsResponse instance

This operation allows a search on TABLE resources by LFTags. This will be used by admins who want to grant user permissions on certain LFTags. 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.

UpdateLFTag

TagKey => Str
[CatalogId => Str]
[TagValuesToAdd => ArrayRef[Str|Undef]]
[TagValuesToDelete => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::LakeFormation::UpdateLFTag

Returns: a Paws::LakeFormation::UpdateLFTagResponse instance

Updates the list of possible values for the specified tag key. If the 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 tag key's value.

UpdateResource

ResourceArn => Str
RoleArn => Str

Each argument is described in detail in: Paws::LakeFormation::UpdateResource

Returns: a Paws::LakeFormation::UpdateResourceResponse instance

Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues