LakeFormation class

Defines the public endpoint for the AWS Lake Formation service.

Constructors

LakeFormation({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

batchGrantPermissions({required List<BatchPermissionsRequestEntry> entries, String? catalogId}) → Future<BatchGrantPermissionsResponse>

Batch operation to grant permissions to the principal.

batchRevokePermissions({required List<BatchPermissionsRequestEntry> entries, String? catalogId}) → Future<BatchRevokePermissionsResponse>

Batch operation to revoke permissions from the principal.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

deregisterResource({required String resourceArn}) → Future<void>

Deregisters the resource as managed by the Data Catalog.

describeResource({required String resourceArn}) → Future<DescribeResourceResponse>

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

getDataLakeSettings({String? catalogId}) → Future<GetDataLakeSettingsResponse>

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

getEffectivePermissionsForPath({required String resourceArn, String? catalogId, int? maxResults, String? nextToken}) → Future<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.

grantPermissions({required List<Permission> permissions, required DataLakePrincipal principal, required Resource resource, String? catalogId, List<Permission>? permissionsWithGrantOption}) → Future<void>

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

listPermissions({String? catalogId, int? maxResults, String? nextToken, DataLakePrincipal? principal, Resource? resource, DataLakeResourceType? resourceType}) → Future<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.

listResources({List<FilterCondition>? filterConditionList, int? maxResults, String? nextToken}) → Future<ListResourcesResponse>

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

putDataLakeSettings({required DataLakeSettings dataLakeSettings, String? catalogId}) → Future<void>

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.

registerResource({required String resourceArn, String? roleArn, bool? useServiceLinkedRole}) → Future<void>

Registers the resource as managed by the Data Catalog.

revokePermissions({required List<Permission> permissions, required DataLakePrincipal principal, required Resource resource, String? catalogId, List<Permission>? permissionsWithGrantOption}) → Future<void>

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

toString() → String

A string representation of this object.

inherited

updateResource({required String resourceArn, required String roleArn}) → Future<void>

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

Operators

operator ==(Object other) → bool

The equality operator.

inherited