LakeFormation

public struct LakeFormation

Client object for interacting with AWS LakeFormation service.

AWS Lake Formation Defines the public endpoint for the AWS Lake Formation service.

Member variables

Initialization

  • Initialize the LakeFormation client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • Batch operation to grant permissions to the principal.

    Declaration

    Swift

    public func batchGrantPermissions(_ input: BatchGrantPermissionsRequest) -> EventLoopFuture<BatchGrantPermissionsResponse>

  • Batch operation to revoke permissions from the principal.

    Declaration

    Swift

    public func batchRevokePermissions(_ input: BatchRevokePermissionsRequest) -> EventLoopFuture<BatchRevokePermissionsResponse>

  • 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.

    Declaration

    Swift

    public func deregisterResource(_ input: DeregisterResourceRequest) -> EventLoopFuture<DeregisterResourceResponse>

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

    Declaration

    Swift

    public func describeResource(_ input: DescribeResourceRequest) -> EventLoopFuture<DescribeResourceResponse>

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

    Declaration

    Swift

    public func getDataLakeSettings(_ input: GetDataLakeSettingsRequest) -> EventLoopFuture<GetDataLakeSettingsResponse>

  • 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.

    Declaration

    Swift

    public func getEffectivePermissionsForPath(_ input: GetEffectivePermissionsForPathRequest) -> EventLoopFuture<GetEffectivePermissionsForPathResponse>

  • 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.

    Declaration

    Swift

    public func grantPermissions(_ input: GrantPermissionsRequest) -> EventLoopFuture<GrantPermissionsResponse>

  • 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.

    Declaration

    Swift

    public func listPermissions(_ input: ListPermissionsRequest) -> EventLoopFuture<ListPermissionsResponse>

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

    Declaration

    Swift

    public func listResources(_ input: ListResourcesRequest) -> EventLoopFuture<ListResourcesResponse>

  • 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.

    Declaration

    Swift

    public func putDataLakeSettings(_ input: PutDataLakeSettingsRequest) -> EventLoopFuture<PutDataLakeSettingsResponse>

  • 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

    Declaration

    Swift

    public func registerResource(_ input: RegisterResourceRequest) -> EventLoopFuture<RegisterResourceResponse>

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

    Declaration

    Swift

    public func revokePermissions(_ input: RevokePermissionsRequest) -> EventLoopFuture<RevokePermissionsResponse>

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

    Declaration

    Swift

    public func updateResource(_ input: UpdateResourceRequest) -> EventLoopFuture<UpdateResourceResponse>

Paginators

  • 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.

    Declaration

    Swift

    public func getEffectivePermissionsForPathPaginator(_ input: GetEffectivePermissionsForPathRequest, onPage: @escaping (GetEffectivePermissionsForPathResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func listPermissionsPaginator(_ input: ListPermissionsRequest, onPage: @escaping (ListPermissionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func listResourcesPaginator(_ input: ListResourcesRequest, onPage: @escaping (ListResourcesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum ComparisonOperator : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum DataLakeResourceType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum FieldNameString : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum Permission : String, CustomStringConvertible, Codable