LakeFormation
Service object for interacting with AWS LakeFormation service.
public struct LakeFormation: AWSService
Defines the public endpoint for the Lake Formation service.
Inheritance
AWSService
Initializers
init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the LakeFormation client
public init(
client: AWSClient,
region: SotoCore.Region? = nil,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: LakeFormation, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
addLFTagsToResource(_:logger:on:)
public func addLFTagsToResource(_ input: AddLFTagsToResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<AddLFTagsToResourceResponse>
Attaches one or more LF-tags to an existing resource.
batchGrantPermissions(_:logger:on:)
public func batchGrantPermissions(_ input: BatchGrantPermissionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<BatchGrantPermissionsResponse>
Batch operation to grant permissions to the principal.
batchRevokePermissions(_:logger:on:)
public func batchRevokePermissions(_ input: BatchRevokePermissionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<BatchRevokePermissionsResponse>
Batch operation to revoke permissions from the principal.
cancelTransaction(_:logger:on:)
public func cancelTransaction(_ input: CancelTransactionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CancelTransactionResponse>
Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
commitTransaction(_:logger:on:)
public func commitTransaction(_ input: CommitTransactionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
createDataCellsFilter(_:logger:on:)
public func createDataCellsFilter(_ input: CreateDataCellsFilterRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDataCellsFilterResponse>
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
createLFTag(_:logger:on:)
public func createLFTag(_ input: CreateLFTagRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateLFTagResponse>
Creates an LF-tag with the specified name and values.
deleteDataCellsFilter(_:logger:on:)
public func deleteDataCellsFilter(_ input: DeleteDataCellsFilterRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteDataCellsFilterResponse>
Deletes a data cell filter.
deleteLFTag(_:logger:on:)
public func deleteLFTag(_ input: DeleteLFTagRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteLFTagResponse>
Deletes the specified LF-tag key name. If the attribute key does not exist or the LF-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 LF-tag key is still attached with resources. You can consider untagging resources with this LF-tag key.
deleteObjectsOnCancel(_:logger:on:)
public func deleteObjectsOnCancel(_ input: DeleteObjectsOnCancelRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteObjectsOnCancelResponse>
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.
deregisterResource(_:logger:on:)
public func deregisterResource(_ input: DeregisterResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeregisterResourceResponse>
Deregisters the resource as managed by the Data Catalog.
<p>When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.</p>
describeResource(_:logger:on:)
public func describeResource(_ input: DescribeResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeResourceResponse>
Retrieves the current data access role for the given resource registered in Lake Formation.
describeTransaction(_:logger:on:)
public func describeTransaction(_ input: DescribeTransactionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeTransactionResponse>
Returns the details of a single transaction.
extendTransaction(_:logger:on:)
public func extendTransaction(_ input: ExtendTransactionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ExtendTransactionResponse>
Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
<p>Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.</p>
getDataLakeSettings(_:logger:on:)
public func getDataLakeSettings(_ input: GetDataLakeSettingsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetDataLakeSettingsResponse>
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
getEffectivePermissionsForPath(_:logger:on:)
public func getEffectivePermissionsForPath(_ input: GetEffectivePermissionsForPathRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
getLFTag(_:logger:on:)
public func getLFTag(_ input: GetLFTagRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetLFTagResponse>
Returns an LF-tag definition.
getQueryState(_:logger:on:)
public func getQueryState(_ input: GetQueryStateRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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
.
getQueryStatistics(_:logger:on:)
public func getQueryStatistics(_ input: GetQueryStatisticsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetQueryStatisticsResponse>
Retrieves statistics on the planning and execution of a query.
getResourceLFTags(_:logger:on:)
public func getResourceLFTags(_ input: GetResourceLFTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetResourceLFTagsResponse>
Returns the LF-tags applied to a resource.
getTableObjects(_:logger:on:)
public func getTableObjects(_ input: GetTableObjectsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
getTemporaryGluePartitionCredentials(_:logger:on:)
public func getTemporaryGluePartitionCredentials(_ input: GetTemporaryGluePartitionCredentialsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
getTemporaryGlueTableCredentials(_:logger:on:)
public func getTemporaryGlueTableCredentials(_ input: GetTemporaryGlueTableCredentialsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
getWorkUnitResults(_:logger:on:)
public func getWorkUnitResults(_ input: GetWorkUnitResultsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetWorkUnitResultsResponse>
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
getWorkUnits(_:logger:on:)
public func getWorkUnits(_ input: GetWorkUnitsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetWorkUnitsResponse>
Retrieves the work units generated by the StartQueryPlanning
operation.
grantPermissions(_:logger:on:)
public func grantPermissions(_ input: GrantPermissionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GrantPermissionsResponse>
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.
listDataCellsFilter(_:logger:on:)
public func listDataCellsFilter(_ input: ListDataCellsFilterRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListDataCellsFilterResponse>
Lists all the data cell filters on a table.
listLFTags(_:logger:on:)
public func listLFTags(_ input: ListLFTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListLFTagsResponse>
Lists LF-tags that the requester has permission to view.
listPermissions(_:logger:on:)
public func listPermissions(_ input: ListPermissionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
listResources(_:logger:on:)
public func listResources(_ input: ListResourcesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListResourcesResponse>
Lists the resources registered to be managed by the Data Catalog.
listTableStorageOptimizers(_:logger:on:)
public func listTableStorageOptimizers(_ input: ListTableStorageOptimizersRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTableStorageOptimizersResponse>
Returns the configuration of all storage optimizers associated with a specified table.
listTransactions(_:logger:on:)
public func listTransactions(_ input: ListTransactionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
putDataLakeSettings(_:logger:on:)
public func putDataLakeSettings(_ input: PutDataLakeSettingsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PutDataLakeSettingsResponse>
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.
<p>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.</p>
registerResource(_:logger:on:)
UseServiceLinkedRole = true
public func registerResource(_ input: RegisterResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RegisterResourceResponse>
Registers the resource as managed by the Data Catalog.
<p>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.</p>
<p>The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.</p>
<p>
<code>ResourceArn = arn:aws:s3:::my-bucket
<p>If <code>UseServiceLinkedRole</code> is not set to true, you must provide or set the <code>RoleArn</code>:</p>
<p>
<code>arn:aws:iam::12345:role/my-data-access-role</code>
</p>
removeLFTagsFromResource(_:logger:on:)
public func removeLFTagsFromResource(_ input: RemoveLFTagsFromResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
revokePermissions(_:logger:on:)
public func revokePermissions(_ input: RevokePermissionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<RevokePermissionsResponse>
Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
searchDatabasesByLFTags(_:logger:on:)
public func searchDatabasesByLFTags(_ input: SearchDatabasesByLFTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<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.
searchTablesByLFTags(_:logger:on:)
public func searchTablesByLFTags(_ input: SearchTablesByLFTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<SearchTablesByLFTagsResponse>
This operation allows a search on TABLE
resources by LFTag
s. 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 LFTag
s are valid to verify whether the returned resources can be shared.
startQueryPlanning(_:logger:on:)
public func startQueryPlanning(_ input: StartQueryPlanningRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartQueryPlanningResponse>
Submits a request to process a query statement.
<p>This operation generates work units that can be retrieved with the <code>GetWorkUnits</code> operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED.</p>
startTransaction(_:logger:on:)
public func startTransaction(_ input: StartTransactionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartTransactionResponse>
Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
updateLFTag(_:logger:on:)
public func updateLFTag(_ input: UpdateLFTagRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateLFTagResponse>
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.
updateResource(_:logger:on:)
public func updateResource(_ input: UpdateResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateResourceResponse>
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
updateTableObjects(_:logger:on:)
public func updateTableObjects(_ input: UpdateTableObjectsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateTableObjectsResponse>
Updates the manifest of Amazon S3 objects that make up the specified governed table.
updateTableStorageOptimizer(_:logger:on:)
public func updateTableStorageOptimizer(_ input: UpdateTableStorageOptimizerRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateTableStorageOptimizerResponse>
Updates the configuration of the storage optimizers for a table.
getWorkUnitResultsStreaming(_:logger:on:_:)
public func getWorkUnitResultsStreaming(_ input: GetWorkUnitResultsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil, _ stream: @escaping (ByteBuffer, EventLoop)->EventLoopFuture<Void>) -> EventLoopFuture<GetWorkUnitResultsResponse>
Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
getEffectivePermissionsForPathPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getEffectivePermissionsForPathPaginator( _ input: GetEffectivePermissionsForPathRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetEffectivePermissionsForPathRequest, GetEffectivePermissionsForPathResponse>
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onGetEffectivePermissionsForPath
will not return databases and tables if the catalog is encrypted.
getTableObjectsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getTableObjectsPaginator( _ input: GetTableObjectsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetTableObjectsRequest, 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.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
getWorkUnitsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func getWorkUnitsPaginator( _ input: GetWorkUnitsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<GetWorkUnitsRequest, GetWorkUnitsResponse>
Retrieves the work units generated by the
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onStartQueryPlanning
operation.
listDataCellsFilterPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listDataCellsFilterPaginator( _ input: ListDataCellsFilterRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListDataCellsFilterRequest, ListDataCellsFilterResponse>
Lists all the data cell filters on a table.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listLFTagsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listLFTagsPaginator( _ input: ListLFTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListLFTagsRequest, ListLFTagsResponse>
Lists LF-tags that the requester has permission to view.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listPermissionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listPermissionsPaginator( _ input: ListPermissionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListPermissionsRequest, 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.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listResourcesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listResourcesPaginator( _ input: ListResourcesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListResourcesRequest, ListResourcesResponse>
Lists the resources registered to be managed by the Data Catalog.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listTableStorageOptimizersPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listTableStorageOptimizersPaginator( _ input: ListTableStorageOptimizersRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListTableStorageOptimizersRequest, ListTableStorageOptimizersResponse>
Returns the configuration of all storage optimizers associated with a specified table.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listTransactionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listTransactionsPaginator( _ input: ListTransactionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListTransactionsRequest, 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.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
searchDatabasesByLFTagsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func searchDatabasesByLFTagsPaginator( _ input: SearchDatabasesByLFTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<SearchDatabasesByLFTagsRequest, SearchDatabasesByLFTagsResponse>
This operation allows a search on
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onDATABASE
resources byTagCondition
. This operation is used by admins who want to grant user permissions on certainTagConditions
. Before making a grant, the admin can useSearchDatabasesByTags
to find all resources where the givenTagConditions
are valid to verify whether the returned resources can be shared.
searchTablesByLFTagsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func searchTablesByLFTagsPaginator( _ input: SearchTablesByLFTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<SearchTablesByLFTagsRequest, SearchTablesByLFTagsResponse>
This operation allows a search on
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process onTABLE
resources byLFTag
s. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can useSearchTablesByLFTags
to find all resources where the givenLFTag
s are valid to verify whether the returned resources can be shared.
getEffectivePermissionsForPathPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getEffectivePermissionsForPathPaginator<Result>(
_ input: GetEffectivePermissionsForPathRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetEffectivePermissionsForPathResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
getEffectivePermissionsForPathPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getEffectivePermissionsForPathPaginator(
_ input: GetEffectivePermissionsForPathRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetEffectivePermissionsForPathResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getTableObjectsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getTableObjectsPaginator<Result>(
_ input: GetTableObjectsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetTableObjectsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.getTableObjectsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getTableObjectsPaginator(
_ input: GetTableObjectsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetTableObjectsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.getWorkUnitsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func getWorkUnitsPaginator<Result>(
_ input: GetWorkUnitsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, GetWorkUnitsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Retrieves the work units generated by the StartQueryPlanning
operation.
getWorkUnitsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func getWorkUnitsPaginator(
_ input: GetWorkUnitsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (GetWorkUnitsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listDataCellsFilterPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listDataCellsFilterPaginator<Result>(
_ input: ListDataCellsFilterRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListDataCellsFilterResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists all the data cell filters on a table.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.listDataCellsFilterPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listDataCellsFilterPaginator(
_ input: ListDataCellsFilterRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListDataCellsFilterResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listLFTagsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listLFTagsPaginator<Result>(
_ input: ListLFTagsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListLFTagsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists LF-tags that the requester has permission to view.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.listLFTagsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listLFTagsPaginator(
_ input: ListLFTagsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListLFTagsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listPermissionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listPermissionsPaginator<Result>(
_ input: ListPermissionsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListPermissionsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.listPermissionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listPermissionsPaginator(
_ input: ListPermissionsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListPermissionsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listResourcesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listResourcesPaginator<Result>(
_ input: ListResourcesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListResourcesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists the resources registered to be managed by the Data Catalog.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.listResourcesPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listResourcesPaginator(
_ input: ListResourcesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListResourcesResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listTableStorageOptimizersPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listTableStorageOptimizersPaginator<Result>(
_ input: ListTableStorageOptimizersRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListTableStorageOptimizersResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Returns the configuration of all storage optimizers associated with a specified table.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.listTableStorageOptimizersPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listTableStorageOptimizersPaginator(
_ input: ListTableStorageOptimizersRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListTableStorageOptimizersResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.listTransactionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func listTransactionsPaginator<Result>(
_ input: ListTransactionsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListTransactionsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
Parameters: - input: Input for request - initialValue: The value to use as the initial accumulating value. `initialValue` is passed to `onPage` the first time it is called. - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.listTransactionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func listTransactionsPaginator(
_ input: ListTransactionsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListTransactionsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.searchDatabasesByLFTagsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func searchDatabasesByLFTagsPaginator<Result>(
_ input: SearchDatabasesByLFTagsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, SearchDatabasesByLFTagsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
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.
searchDatabasesByLFTagsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func searchDatabasesByLFTagsPaginator(
_ input: SearchDatabasesByLFTagsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (SearchDatabasesByLFTagsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on - onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.searchTablesByLFTagsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure `onPage` for it to combine them into one result.
This works in a similar manner to `Array.reducepublic func searchTablesByLFTagsPaginator<Result>(
_ input: SearchTablesByLFTagsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, SearchTablesByLFTagsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
This operation allows a search on TABLE
resources by LFTag
s. 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 LFTag
s are valid to verify whether the returned resources can be shared.
searchTablesByLFTagsPaginator(_:logger:on:onPage:)
Provide paginated results to closure `onPage`.public func searchTablesByLFTagsPaginator(
_ input: SearchTablesByLFTagsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (SearchTablesByLFTagsResponse, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>