Struct aws_sdk_lakeformation::client::Client

source · [−]

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Expand description

Client for AWS Lake Formation

Client for invoking operations on AWS Lake Formation. Each operation on AWS Lake Formation is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_lakeformation::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_lakeformation::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_lakeformation::Client::from_conf(config);

Implementations

source

impl<C, M, R> Client<C, M, R>

source

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl<C, M, R> Client<C, M, R> where
 C: SmithyConnector,
 M: SmithyMiddleware<C>,
 R: NewRequestPolicy,

source

pub fn add_lf_tags_to_resource(&self) -> AddLFTagsToResource<C, M, R>

Constructs a fluent builder for the AddLFTagsToResource operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- resource(Resource) / set_resource(Option<Resource>):
 The database, table, or column resource to which to attach an LF-tag.
- lf_tags(Vec<LfTagPair>) / set_lf_tags(Option<Vec<LfTagPair>>):
 The LF-tags to attach to the resource.
On success, responds with AddLfTagsToResourceOutput with field(s):
- failures(Option<Vec<LfTagError>>):
 A list of failures to tag the resource.
On failure, responds with SdkError<AddLFTagsToResourceError>

source

pub fn batch_grant_permissions(&self) -> BatchGrantPermissions<C, M, R>

Constructs a fluent builder for the BatchGrantPermissions operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- entries(Vec<BatchPermissionsRequestEntry>) / set_entries(Option<Vec<BatchPermissionsRequestEntry>>):
 A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.
On success, responds with BatchGrantPermissionsOutput with field(s):
- failures(Option<Vec<BatchPermissionsFailureEntry>>):
 A list of failures to grant permissions to the resources.
On failure, responds with SdkError<BatchGrantPermissionsError>

source

pub fn batch_revoke_permissions(&self) -> BatchRevokePermissions<C, M, R>

Constructs a fluent builder for the BatchRevokePermissions operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- entries(Vec<BatchPermissionsRequestEntry>) / set_entries(Option<Vec<BatchPermissionsRequestEntry>>):
 A list of up to 20 entries for resource permissions to be revoked by batch operation to the principal.
On success, responds with BatchRevokePermissionsOutput with field(s):
- failures(Option<Vec<BatchPermissionsFailureEntry>>):
 A list of failures to revoke permissions to the resources.
On failure, responds with SdkError<BatchRevokePermissionsError>

source

pub fn cancel_transaction(&self) -> CancelTransaction<C, M, R>

Constructs a fluent builder for the CancelTransaction operation.

The fluent builder is configurable:
- transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
 The transaction to cancel.
On success, responds with CancelTransactionOutput
On failure, responds with SdkError<CancelTransactionError>

source

pub fn commit_transaction(&self) -> CommitTransaction<C, M, R>

Constructs a fluent builder for the CommitTransaction operation.

The fluent builder is configurable:
- transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
 The transaction to commit.
On success, responds with CommitTransactionOutput with field(s):
- transaction_status(Option<TransactionStatus>):
 The status of the transaction.
On failure, responds with SdkError<CommitTransactionError>

source

pub fn create_data_cells_filter(&self) -> CreateDataCellsFilter<C, M, R>

Constructs a fluent builder for the CreateDataCellsFilter operation.

The fluent builder is configurable:
- table_data(DataCellsFilter) / set_table_data(Option<DataCellsFilter>):
 A DataCellsFilter structure containing information about the data cells filter.
On success, responds with CreateDataCellsFilterOutput
On failure, responds with SdkError<CreateDataCellsFilterError>

source

pub fn create_lf_tag(&self) -> CreateLFTag<C, M, R>

Constructs a fluent builder for the CreateLFTag operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- tag_key(impl Into<String>) / set_tag_key(Option<String>):
 The key-name for the LF-tag.
- tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):
 A list of possible values an attribute can take.
On success, responds with CreateLfTagOutput
On failure, responds with SdkError<CreateLFTagError>

source

pub fn delete_data_cells_filter(&self) -> DeleteDataCellsFilter<C, M, R>

Constructs a fluent builder for the DeleteDataCellsFilter operation.

The fluent builder is configurable:
- table_catalog_id(impl Into<String>) / set_table_catalog_id(Option<String>):
 The ID of the catalog to which the table belongs.
- database_name(impl Into<String>) / set_database_name(Option<String>):
 A database in the Glue Data Catalog.
- table_name(impl Into<String>) / set_table_name(Option<String>):
 A table in the database.
- name(impl Into<String>) / set_name(Option<String>):
 The name given by the user to the data filter cell.
On success, responds with DeleteDataCellsFilterOutput
On failure, responds with SdkError<DeleteDataCellsFilterError>

source

pub fn delete_lf_tag(&self) -> DeleteLFTag<C, M, R>

Constructs a fluent builder for the DeleteLFTag operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- tag_key(impl Into<String>) / set_tag_key(Option<String>):
 The key-name for the LF-tag to delete.
On success, responds with DeleteLfTagOutput
On failure, responds with SdkError<DeleteLFTagError>

source

pub fn delete_objects_on_cancel(&self) -> DeleteObjectsOnCancel<C, M, R>

Constructs a fluent builder for the DeleteObjectsOnCancel operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The Glue data catalog that contains the governed table. Defaults to the current account ID.
- database_name(impl Into<String>) / set_database_name(Option<String>):
 The database that contains the governed table.
- table_name(impl Into<String>) / set_table_name(Option<String>):
 The name of the governed table.
- transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
 ID of the transaction that the writes occur in.
- objects(Vec<VirtualObject>) / set_objects(Option<Vec<VirtualObject>>):
 A list of VirtualObject structures, which indicates the Amazon S3 objects to be deleted if the transaction cancels.
On success, responds with DeleteObjectsOnCancelOutput
On failure, responds with SdkError<DeleteObjectsOnCancelError>

source

pub fn deregister_resource(&self) -> DeregisterResource<C, M, R>

Constructs a fluent builder for the DeregisterResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the resource that you want to deregister.
On success, responds with DeregisterResourceOutput
On failure, responds with SdkError<DeregisterResourceError>

source

pub fn describe_resource(&self) -> DescribeResource<C, M, R>

Constructs a fluent builder for the DescribeResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The resource ARN.
On success, responds with DescribeResourceOutput with field(s):
- resource_info(Option<ResourceInfo>):
 A structure containing information about an Lake Formation resource.
On failure, responds with SdkError<DescribeResourceError>

source

pub fn describe_transaction(&self) -> DescribeTransaction<C, M, R>

Constructs a fluent builder for the DescribeTransaction operation.

The fluent builder is configurable:
- transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
 The transaction for which to return status.
On success, responds with DescribeTransactionOutput with field(s):
- transaction_description(Option<TransactionDescription>):
 Returns a TransactionDescription object containing information about the transaction.
On failure, responds with SdkError<DescribeTransactionError>

source

pub fn extend_transaction(&self) -> ExtendTransaction<C, M, R>

Constructs a fluent builder for the ExtendTransaction operation.

The fluent builder is configurable:
- transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
 The transaction to extend.
On success, responds with ExtendTransactionOutput
On failure, responds with SdkError<ExtendTransactionError>

source

pub fn get_data_lake_settings(&self) -> GetDataLakeSettings<C, M, R>

Constructs a fluent builder for the GetDataLakeSettings operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
On success, responds with GetDataLakeSettingsOutput with field(s):
- data_lake_settings(Option<DataLakeSettings>):
 A structure representing a list of Lake Formation principals designated as data lake administrators.
On failure, responds with SdkError<GetDataLakeSettingsError>

source

pub fn get_effective_permissions_for_path(
&self
) -> GetEffectivePermissionsForPath<C, M, R>

Constructs a fluent builder for the GetEffectivePermissionsForPath operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the resource for which you want to get permissions.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token, if this is not the first call to retrieve this list.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return.
On success, responds with GetEffectivePermissionsForPathOutput with field(s):
- permissions(Option<Vec<PrincipalResourcePermissions>>):
 A list of the permissions for the specified table or database resource located at the path in Amazon S3.
- next_token(Option<String>):
 A continuation token, if this is not the first call to retrieve this list.
On failure, responds with SdkError<GetEffectivePermissionsForPathError>

source

pub fn get_lf_tag(&self) -> GetLFTag<C, M, R>

Constructs a fluent builder for the GetLFTag operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- tag_key(impl Into<String>) / set_tag_key(Option<String>):
 The key-name for the LF-tag.
On success, responds with GetLfTagOutput with field(s):
- catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- tag_key(Option<String>):
 The key-name for the LF-tag.
- tag_values(Option<Vec<String>>):
 A list of possible values an attribute can take.
On failure, responds with SdkError<GetLFTagError>

source

pub fn get_query_state(&self) -> GetQueryState<C, M, R>

Constructs a fluent builder for the GetQueryState operation.

The fluent builder is configurable:
- query_id(impl Into<String>) / set_query_id(Option<String>):
 The ID of the plan query operation.
On success, responds with GetQueryStateOutput with field(s):
- error(Option<String>):
 An error message when the operation fails.
- state(Option<QueryStateString>):
 The state of a query previously submitted. The possible states are:
 - PENDING: the query is pending.
 - WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.
 - FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.
 - ERROR: an error occurred with the query, such as an invalid query ID or a backend error.
On failure, responds with SdkError<GetQueryStateError>

source

pub fn get_query_statistics(&self) -> GetQueryStatistics<C, M, R>

Constructs a fluent builder for the GetQueryStatistics operation.

The fluent builder is configurable:
- query_id(impl Into<String>) / set_query_id(Option<String>):
 The ID of the plan query operation.
On success, responds with GetQueryStatisticsOutput with field(s):
- execution_statistics(Option<ExecutionStatistics>):
 An ExecutionStatistics structure containing execution statistics.
- planning_statistics(Option<PlanningStatistics>):
 A PlanningStatistics structure containing query planning statistics.
- query_submission_time(Option<DateTime>):
 The time that the query was submitted.
On failure, responds with SdkError<GetQueryStatisticsError>

source

pub fn get_resource_lf_tags(&self) -> GetResourceLFTags<C, M, R>

Constructs a fluent builder for the GetResourceLFTags operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- resource(Resource) / set_resource(Option<Resource>):
 The database, table, or column resource for which you want to return LF-tags.
- show_assigned_lf_tags(bool) / set_show_assigned_lf_tags(Option<bool>):
 Indicates whether to show the assigned LF-tags.
On success, responds with GetResourceLfTagsOutput with field(s):
- lf_tag_on_database(Option<Vec<LfTagPair>>):
 A list of LF-tags applied to a database resource.
- lf_tags_on_table(Option<Vec<LfTagPair>>):
 A list of LF-tags applied to a table resource.
- lf_tags_on_columns(Option<Vec<ColumnLfTag>>):
 A list of LF-tags applied to a column resource.
On failure, responds with SdkError<GetResourceLFTagsError>

source

pub fn get_table_objects(&self) -> GetTableObjects<C, M, R>

Constructs a fluent builder for the GetTableObjects operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The catalog containing the governed table. Defaults to the caller’s account.
- database_name(impl Into<String>) / set_database_name(Option<String>):
 The database containing the governed table.
- table_name(impl Into<String>) / set_table_name(Option<String>):
 The governed table for which to retrieve objects.
- transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
 The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.
- query_as_of_time(DateTime) / set_query_as_of_time(Option<DateTime>):
 The time as of when to read the governed table contents. If not set, the most recent transaction commit time is used. Cannot be specified along with TransactionId.
- partition_predicate(impl Into<String>) / set_partition_predicate(Option<String>):
 A predicate to filter the objects returned based on the partition keys defined in the governed table.
 - The comparison operators supported are: =, >, <, >=, <=
 - The logical operators supported are: AND
 - The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss“), string and decimal.
- max_results(i32) / set_max_results(Option<i32>):
 Specifies how many values to return in a page.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token if this is not the first call to retrieve these objects.
On success, responds with GetTableObjectsOutput with field(s):
- objects(Option<Vec<PartitionObjects>>):
 A list of objects organized by partition keys.
- next_token(Option<String>):
 A continuation token indicating whether additional data is available.
On failure, responds with SdkError<GetTableObjectsError>

source

pub fn get_temporary_glue_partition_credentials(
&self
) -> GetTemporaryGluePartitionCredentials<C, M, R>

Constructs a fluent builder for the GetTemporaryGluePartitionCredentials operation.

The fluent builder is configurable:
- table_arn(impl Into<String>) / set_table_arn(Option<String>):
 The ARN of the partitions’ table.
- partition(PartitionValueList) / set_partition(Option<PartitionValueList>):
 A list of partition values identifying a single partition.
- permissions(Vec<Permission>) / set_permissions(Option<Vec<Permission>>):
 Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).
- duration_seconds(i32) / set_duration_seconds(Option<i32>):
 The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
- audit_context(AuditContext) / set_audit_context(Option<AuditContext>):
 A structure representing context to access a resource (column names, query ID, etc).
- supported_permission_types(Vec<PermissionType>) / set_supported_permission_types(Option<Vec<PermissionType>>):
 A list of supported permission types for the partition. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.
On success, responds with GetTemporaryGluePartitionCredentialsOutput with field(s):
- access_key_id(Option<String>):
 The access key ID for the temporary credentials.
- secret_access_key(Option<String>):
 The secret key for the temporary credentials.
- session_token(Option<String>):
 The session token for the temporary credentials.
- expiration(Option<DateTime>):
 The date and time when the temporary credentials expire.
On failure, responds with SdkError<GetTemporaryGluePartitionCredentialsError>

source

pub fn get_temporary_glue_table_credentials(
&self
) -> GetTemporaryGlueTableCredentials<C, M, R>

Constructs a fluent builder for the GetTemporaryGlueTableCredentials operation.

The fluent builder is configurable:
- table_arn(impl Into<String>) / set_table_arn(Option<String>):
 The ARN identifying a table in the Data Catalog for the temporary credentials request.
- permissions(Vec<Permission>) / set_permissions(Option<Vec<Permission>>):
 Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).
- duration_seconds(i32) / set_duration_seconds(Option<i32>):
 The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
- audit_context(AuditContext) / set_audit_context(Option<AuditContext>):
 A structure representing context to access a resource (column names, query ID, etc).
- supported_permission_types(Vec<PermissionType>) / set_supported_permission_types(Option<Vec<PermissionType>>):
 A list of supported permission types for the table. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.
On success, responds with GetTemporaryGlueTableCredentialsOutput with field(s):
- access_key_id(Option<String>):
 The access key ID for the temporary credentials.
- secret_access_key(Option<String>):
 The secret key for the temporary credentials.
- session_token(Option<String>):
 The session token for the temporary credentials.
- expiration(Option<DateTime>):
 The date and time when the temporary credentials expire.
On failure, responds with SdkError<GetTemporaryGlueTableCredentialsError>

source

pub fn get_work_unit_results(&self) -> GetWorkUnitResults<C, M, R>

Constructs a fluent builder for the GetWorkUnitResults operation.

The fluent builder is configurable:
- query_id(impl Into<String>) / set_query_id(Option<String>):
 The ID of the plan query operation for which to get results.
- work_unit_id(i64) / set_work_unit_id(i64):
 The work unit ID for which to get results. Value generated by enumerating WorkUnitIdMin to WorkUnitIdMax (inclusive) from the WorkUnitRange in the output of GetWorkUnits.
- work_unit_token(impl Into<String>) / set_work_unit_token(Option<String>):
 A work token used to query the execution service. Token output from GetWorkUnits.
On success, responds with GetWorkUnitResultsOutput with field(s):
- result_stream(byte_stream::ByteStream):
  Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0 messages.
On failure, responds with SdkError<GetWorkUnitResultsError>

source

pub fn get_work_units(&self) -> GetWorkUnits<C, M, R>

Constructs a fluent builder for the GetWorkUnits operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token, if this is a continuation call.
- page_size(i32) / set_page_size(Option<i32>):
 The size of each page to get in the Amazon Web Services service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the Amazon Web Services service, retrieving fewer items in each call. This can help prevent the Amazon Web Services service calls from timing out.
- query_id(impl Into<String>) / set_query_id(Option<String>):
 The ID of the plan query operation.
On success, responds with GetWorkUnitsOutput with field(s):
- next_token(Option<String>):
 A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
- query_id(Option<String>):
 The ID of the plan query operation.
- work_unit_ranges(Option<Vec<WorkUnitRange>>):
 A WorkUnitRangeList object that specifies the valid range of work unit IDs for querying the execution service.
On failure, responds with SdkError<GetWorkUnitsError>

source

pub fn grant_permissions(&self) -> GrantPermissions<C, M, R>

Constructs a fluent builder for the GrantPermissions operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- principal(DataLakePrincipal) / set_principal(Option<DataLakePrincipal>):
 The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.
 
 Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.
- resource(Resource) / set_resource(Option<Resource>):
 The resource to which permissions are to be granted. Resources in Lake Formation are the Data Catalog, databases, and tables.
- permissions(Vec<Permission>) / set_permissions(Option<Vec<Permission>>):
 The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.
- permissions_with_grant_option(Vec<Permission>) / set_permissions_with_grant_option(Option<Vec<Permission>>):
 Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.
On success, responds with GrantPermissionsOutput
On failure, responds with SdkError<GrantPermissionsError>

source

pub fn list_data_cells_filter(&self) -> ListDataCellsFilter<C, M, R>

Constructs a fluent builder for the ListDataCellsFilter operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- table(TableResource) / set_table(Option<TableResource>):
 A table in the Glue Data Catalog.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token, if this is a continuation call.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum size of the response.
On success, responds with ListDataCellsFilterOutput with field(s):
- data_cells_filters(Option<Vec<DataCellsFilter>>):
 A list of DataCellFilter structures.
- next_token(Option<String>):
 A continuation token, if not all requested data cell filters have been returned.
On failure, responds with SdkError<ListDataCellsFilterError>

source

pub fn list_lf_tags(&self) -> ListLFTags<C, M, R>

Constructs a fluent builder for the ListLFTags operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- resource_share_type(ResourceShareType) / set_resource_share_type(Option<ResourceShareType>):
 If resource share type is ALL, returns both in-account LF-tags and shared LF-tags that the requester has permission to view. If resource share type is FOREIGN, returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-tags in the given catalog ID that the requester has permission to view.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token, if this is not the first call to retrieve this list.
On success, responds with ListLfTagsOutput with field(s):
- lf_tags(Option<Vec<LfTagPair>>):
 A list of LF-tags that the requested has permission to view.
- next_token(Option<String>):
 A continuation token, present if the current list segment is not the last.
On failure, responds with SdkError<ListLFTagsError>

source

pub fn list_permissions(&self) -> ListPermissions<C, M, R>

Constructs a fluent builder for the ListPermissions operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- principal(DataLakePrincipal) / set_principal(Option<DataLakePrincipal>):
 Specifies a principal to filter the permissions returned.
- resource_type(DataLakeResourceType) / set_resource_type(Option<DataLakeResourceType>):
 Specifies a resource type to filter the permissions returned.
- resource(Resource) / set_resource(Option<Resource>):
 A resource where you will get a list of the principal permissions.
 
 This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token, if this is not the first call to retrieve this list.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return.
- include_related(impl Into<String>) / set_include_related(Option<String>):
 Indicates that related permissions should be included in the results.
On success, responds with ListPermissionsOutput with field(s):
- principal_resource_permissions(Option<Vec<PrincipalResourcePermissions>>):
 A list of principals and their permissions on the resource for the specified principal and resource types.
- next_token(Option<String>):
 A continuation token, if this is not the first call to retrieve this list.
On failure, responds with SdkError<ListPermissionsError>

source

pub fn list_resources(&self) -> ListResources<C, M, R>

Constructs a fluent builder for the ListResources operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- filter_condition_list(Vec<FilterCondition>) / set_filter_condition_list(Option<Vec<FilterCondition>>):
 Any applicable row-level and/or column-level filtering conditions for the resources.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of resource results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token, if this is not the first call to retrieve these resources.
On success, responds with ListResourcesOutput with field(s):
- resource_info_list(Option<Vec<ResourceInfo>>):
 A summary of the data lake resources.
- next_token(Option<String>):
 A continuation token, if this is not the first call to retrieve these resources.
On failure, responds with SdkError<ListResourcesError>

source

pub fn list_table_storage_optimizers(
&self
) -> ListTableStorageOptimizers<C, M, R>

Constructs a fluent builder for the ListTableStorageOptimizers operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The Catalog ID of the table.
- database_name(impl Into<String>) / set_database_name(Option<String>):
 Name of the database where the table is present.
- table_name(impl Into<String>) / set_table_name(Option<String>):
 Name of the table.
- storage_optimizer_type(OptimizerType) / set_storage_optimizer_type(Option<OptimizerType>):
 The specific type of storage optimizers to list. The supported value is compaction.
- max_results(i32) / set_max_results(Option<i32>):
 The number of storage optimizers to return on each call.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token, if this is a continuation call.
On success, responds with ListTableStorageOptimizersOutput with field(s):
- storage_optimizer_list(Option<Vec<StorageOptimizer>>):
 A list of the storage optimizers associated with a table.
- next_token(Option<String>):
 A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
On failure, responds with SdkError<ListTableStorageOptimizersError>

source

pub fn list_transactions(&self) -> ListTransactions<C, M, R>

Constructs a fluent builder for the ListTransactions operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The catalog for which to list transactions. Defaults to the account ID of the caller.
- status_filter(TransactionStatusFilter) / set_status_filter(Option<TransactionStatusFilter>):
 A filter indicating the status of transactions to return. Options are ALL | COMPLETED | COMMITTED | ABORTED | ACTIVE. The default is ALL.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of transactions to return in a single call.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token if this is not the first call to retrieve transactions.
On success, responds with ListTransactionsOutput with field(s):
- transactions(Option<Vec<TransactionDescription>>):
 A list of transactions. The record for each transaction is a TransactionDescription object.
- next_token(Option<String>):
 A continuation token indicating whether additional data is available.
On failure, responds with SdkError<ListTransactionsError>

source

pub fn put_data_lake_settings(&self) -> PutDataLakeSettings<C, M, R>

Constructs a fluent builder for the PutDataLakeSettings operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- data_lake_settings(DataLakeSettings) / set_data_lake_settings(Option<DataLakeSettings>):
 A structure representing a list of Lake Formation principals designated as data lake administrators.
On success, responds with PutDataLakeSettingsOutput
On failure, responds with SdkError<PutDataLakeSettingsError>

source

pub fn register_resource(&self) -> RegisterResource<C, M, R>

Constructs a fluent builder for the RegisterResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the resource that you want to register.
- use_service_linked_role(bool) / set_use_service_linked_role(Option<bool>):
 Designates an Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation.
 
 For more information, see Using Service-Linked Roles for Lake Formation.
- role_arn(impl Into<String>) / set_role_arn(Option<String>):
 The identifier for the role that registers the resource.
On success, responds with RegisterResourceOutput
On failure, responds with SdkError<RegisterResourceError>

source

pub fn remove_lf_tags_from_resource(&self) -> RemoveLFTagsFromResource<C, M, R>

Constructs a fluent builder for the RemoveLFTagsFromResource operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- resource(Resource) / set_resource(Option<Resource>):
 The database, table, or column resource where you want to remove an LF-tag.
- lf_tags(Vec<LfTagPair>) / set_lf_tags(Option<Vec<LfTagPair>>):
 The LF-tags to be removed from the resource.
On success, responds with RemoveLfTagsFromResourceOutput with field(s):
- failures(Option<Vec<LfTagError>>):
 A list of failures to untag a resource.
On failure, responds with SdkError<RemoveLFTagsFromResourceError>

source

pub fn revoke_permissions(&self) -> RevokePermissions<C, M, R>

Constructs a fluent builder for the RevokePermissions operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- principal(DataLakePrincipal) / set_principal(Option<DataLakePrincipal>):
 The principal to be revoked permissions on the resource.
- resource(Resource) / set_resource(Option<Resource>):
 The resource to which permissions are to be revoked.
- permissions(Vec<Permission>) / set_permissions(Option<Vec<Permission>>):
 The permissions revoked to the principal on the resource. For information about permissions, see Security and Access Control to Metadata and Data.
- permissions_with_grant_option(Vec<Permission>) / set_permissions_with_grant_option(Option<Vec<Permission>>):
 Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals.
On success, responds with RevokePermissionsOutput
On failure, responds with SdkError<RevokePermissionsError>

source

pub fn search_databases_by_lf_tags(&self) -> SearchDatabasesByLFTags<C, M, R>

Constructs a fluent builder for the SearchDatabasesByLFTags operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token, if this is not the first call to retrieve this list.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return.
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- expression(Vec<LfTag>) / set_expression(Option<Vec<LfTag>>):
 A list of conditions (LFTag structures) to search for in database resources.
On success, responds with SearchDatabasesByLfTagsOutput with field(s):
- next_token(Option<String>):
 A continuation token, present if the current list segment is not the last.
- database_list(Option<Vec<TaggedDatabase>>):
 A list of databases that meet the LF-tag conditions.
On failure, responds with SdkError<SearchDatabasesByLFTagsError>

source

pub fn search_tables_by_lf_tags(&self) -> SearchTablesByLFTags<C, M, R>

Constructs a fluent builder for the SearchTablesByLFTags operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 A continuation token, if this is not the first call to retrieve this list.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return.
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- expression(Vec<LfTag>) / set_expression(Option<Vec<LfTag>>):
 A list of conditions (LFTag structures) to search for in table resources.
On success, responds with SearchTablesByLfTagsOutput with field(s):
- next_token(Option<String>):
 A continuation token, present if the current list segment is not the last.
- table_list(Option<Vec<TaggedTable>>):
 A list of tables that meet the LF-tag conditions.
On failure, responds with SdkError<SearchTablesByLFTagsError>

source

pub fn start_query_planning(&self) -> StartQueryPlanning<C, M, R>

Constructs a fluent builder for the StartQueryPlanning operation.

The fluent builder is configurable:
- query_planning_context(QueryPlanningContext) / set_query_planning_context(Option<QueryPlanningContext>):
 A structure containing information about the query plan.
- query_string(impl Into<String>) / set_query_string(Option<String>):
 A PartiQL query statement used as an input to the planner service.
On success, responds with StartQueryPlanningOutput with field(s):
- query_id(Option<String>):
 The ID of the plan query operation can be used to fetch the actual work unit descriptors that are produced as the result of the operation. The ID is also used to get the query state and as an input to the Execute operation.
On failure, responds with SdkError<StartQueryPlanningError>

source

pub fn start_transaction(&self) -> StartTransaction<C, M, R>

Constructs a fluent builder for the StartTransaction operation.

The fluent builder is configurable:
- transaction_type(TransactionType) / set_transaction_type(Option<TransactionType>):
 Indicates whether this transaction should be read only or read and write. Writes made using a read-only transaction ID will be rejected. Read-only transactions do not need to be committed.
On success, responds with StartTransactionOutput with field(s):
- transaction_id(Option<String>):
 An opaque identifier for the transaction.
On failure, responds with SdkError<StartTransactionError>

source

pub fn update_lf_tag(&self) -> UpdateLFTag<C, M, R>

Constructs a fluent builder for the UpdateLFTag operation.

The fluent builder is configurable:
- catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
- tag_key(impl Into<String>) / set_tag_key(Option<String>):
 The key-name for the LF-tag for which to add or delete values.
- tag_values_to_delete(Vec<String>) / set_tag_values_to_delete(Option<Vec<String>>):
 A list of LF-tag values to delete from the LF-tag.
- tag_values_to_add(Vec<String>) / set_tag_values_to_add(Option<Vec<String>>):
 A list of LF-tag values to add from the LF-tag.
On success, responds with UpdateLfTagOutput
On failure, responds with SdkError<UpdateLFTagError>