Struct aws_sdk_lakeformation::Client

pub struct Client { /* private fields */ }

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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_lakeformation::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_lakeformation::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AddLFTagsToResource operation has a Client::add_lf_tags_to_resource, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.add_lf_tags_to_resource()
    .catalog_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn add_lf_tags_to_resource(&self) -> AddLFTagsToResourceFluentBuilder

Constructs a fluent builder for the AddLFTagsToResource operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    The database, table, or column resource to which to attach an LF-tag.

    
    
  • lf_tags(LfTagPair) / set_lf_tags(Option<Vec::<LfTagPair>>):
    required: true
    

    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>

impl Client

pub fn assume_decorated_role_with_saml( &self ) -> AssumeDecoratedRoleWithSAMLFluentBuilder

Constructs a fluent builder for the AssumeDecoratedRoleWithSAML operation.

• The fluent builder is configurable:
  • saml_assertion(impl Into<String>) / set_saml_assertion(Option<String>):
    required: true
    

    A SAML assertion consisting of an assertion statement for the user who needs temporary credentials. This must match the SAML assertion that was issued to IAM. This must be Base64 encoded.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The role that represents an IAM principal whose scope down policy allows it to call credential vending APIs such as GetTemporaryTableCredentials. The caller must also have iam:PassRole permission on this role.

    
    
  • principal_arn(impl Into<String>) / set_principal_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

    
    
  • duration_seconds(i32) / set_duration_seconds(Option<i32>):
    required: false
    

    The time period, between 900 and 43,200 seconds, for the timeout of the temporary credentials.

    
    
• On success, responds with AssumeDecoratedRoleWithSamlOutput with field(s):
  • access_key_id(Option<String>):

    The access key ID for the temporary credentials. (The access key consists of an access key ID and a secret key).

  • secret_access_key(Option<String>):

    The secret key for the temporary credentials. (The access key consists of an access key ID and a secret key).

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

impl Client

pub fn batch_grant_permissions(&self) -> BatchGrantPermissionsFluentBuilder

Constructs a fluent builder for the BatchGrantPermissions operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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(BatchPermissionsRequestEntry) / set_entries(Option<Vec::<BatchPermissionsRequestEntry>>):
    required: true
    

    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>

impl Client

pub fn batch_revoke_permissions(&self) -> BatchRevokePermissionsFluentBuilder

Constructs a fluent builder for the BatchRevokePermissions operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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(BatchPermissionsRequestEntry) / set_entries(Option<Vec::<BatchPermissionsRequestEntry>>):
    required: true
    

    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>

impl Client

pub fn cancel_transaction(&self) -> CancelTransactionFluentBuilder

Constructs a fluent builder for the CancelTransaction operation.

• The fluent builder is configurable:
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: true
    

    The transaction to cancel.

    
    
• On success, responds with CancelTransactionOutput
• On failure, responds with SdkError<CancelTransactionError>

impl Client

pub fn commit_transaction(&self) -> CommitTransactionFluentBuilder

Constructs a fluent builder for the CommitTransaction operation.

• The fluent builder is configurable:
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn create_data_cells_filter(&self) -> CreateDataCellsFilterFluentBuilder

Constructs a fluent builder for the CreateDataCellsFilter operation.

• The fluent builder is configurable:
  • table_data(DataCellsFilter) / set_table_data(Option<DataCellsFilter>):
    required: true
    

    A DataCellsFilter structure containing information about the data cells filter.

    
    
• On success, responds with CreateDataCellsFilterOutput
• On failure, responds with SdkError<CreateDataCellsFilterError>

impl Client

pub fn create_lake_formation_identity_center_configuration( &self ) -> CreateLakeFormationIdentityCenterConfigurationFluentBuilder

Constructs a fluent builder for the CreateLakeFormationIdentityCenterConfiguration operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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, view definitions, and other control information to manage your Lake Formation environment.

    
    
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: false
    

    The ARN of the IAM Identity Center instance for which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    
    
  • external_filtering(ExternalFilteringConfiguration) / set_external_filtering(Option<ExternalFilteringConfiguration>):
    required: false
    

    A list of the account IDs of Amazon Web Services accounts of third-party applications that are allowed to access data managed by Lake Formation.

    
    
  • share_recipients(DataLakePrincipal) / set_share_recipients(Option<Vec::<DataLakePrincipal>>):
    required: false
    

    A list of Amazon Web Services account IDs and/or Amazon Web Services organization/organizational unit ARNs that are allowed to access data managed by Lake Formation.

    If the ShareRecipients list includes valid values, a resource share is created with the principals you want to have access to the resources.

    If the ShareRecipients value is null or the list is empty, no resource share is created.

    
    
• On success, responds with CreateLakeFormationIdentityCenterConfigurationOutput with field(s):
  • application_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Lake Formation application integrated with IAM Identity Center.

• On failure, responds with SdkError<CreateLakeFormationIdentityCenterConfigurationError>

impl Client

pub fn create_lake_formation_opt_in( &self ) -> CreateLakeFormationOptInFluentBuilder

Constructs a fluent builder for the CreateLakeFormationOptIn operation.

• The fluent builder is configurable:
  • principal(DataLakePrincipal) / set_principal(Option<DataLakePrincipal>):
    required: true
    

    The Lake Formation principal. Supported principals are IAM users or IAM roles.

    
    
  • resource(Resource) / set_resource(Option<Resource>):
    required: true
    

    A structure for the resource.

    
    
• On success, responds with CreateLakeFormationOptInOutput
• On failure, responds with SdkError<CreateLakeFormationOptInError>

impl Client

pub fn create_lf_tag(&self) -> CreateLFTagFluentBuilder

Constructs a fluent builder for the CreateLFTag operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    The key-name for the LF-tag.

    
    
  • tag_values(impl Into<String>) / set_tag_values(Option<Vec::<String>>):
    required: true
    

    A list of possible values an attribute can take.

    
    
• On success, responds with CreateLfTagOutput
• On failure, responds with SdkError<CreateLFTagError>

impl Client

pub fn delete_data_cells_filter(&self) -> DeleteDataCellsFilterFluentBuilder

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>):
    required: false
    

    The ID of the catalog to which the table belongs.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: false
    

    A database in the Glue Data Catalog.

    
    
  • table_name(impl Into<String>) / set_table_name(Option<String>):
    required: false
    

    A table in the database.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name given by the user to the data filter cell.

    
    
• On success, responds with DeleteDataCellsFilterOutput
• On failure, responds with SdkError<DeleteDataCellsFilterError>

impl Client

pub fn delete_lake_formation_identity_center_configuration( &self ) -> DeleteLakeFormationIdentityCenterConfigurationFluentBuilder

Constructs a fluent builder for the DeleteLakeFormationIdentityCenterConfiguration operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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, view definition, and other control information to manage your Lake Formation environment.

    
    
• On success, responds with DeleteLakeFormationIdentityCenterConfigurationOutput
• On failure, responds with SdkError<DeleteLakeFormationIdentityCenterConfigurationError>

impl Client

pub fn delete_lake_formation_opt_in( &self ) -> DeleteLakeFormationOptInFluentBuilder

Constructs a fluent builder for the DeleteLakeFormationOptIn operation.

• The fluent builder is configurable:
  • principal(DataLakePrincipal) / set_principal(Option<DataLakePrincipal>):
    required: true
    

    The Lake Formation principal. Supported principals are IAM users or IAM roles.

    
    
  • resource(Resource) / set_resource(Option<Resource>):
    required: true
    

    A structure for the resource.

    
    
• On success, responds with DeleteLakeFormationOptInOutput
• On failure, responds with SdkError<DeleteLakeFormationOptInError>

impl Client

pub fn delete_lf_tag(&self) -> DeleteLFTagFluentBuilder

Constructs a fluent builder for the DeleteLFTag operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    The key-name for the LF-tag to delete.

    
    
• On success, responds with DeleteLfTagOutput
• On failure, responds with SdkError<DeleteLFTagError>

impl Client

pub fn delete_objects_on_cancel(&self) -> DeleteObjectsOnCancelFluentBuilder

Constructs a fluent builder for the DeleteObjectsOnCancel operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    The database that contains the governed table.

    
    
  • table_name(impl Into<String>) / set_table_name(Option<String>):
    required: true
    

    The name of the governed table.

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: true
    

    ID of the transaction that the writes occur in.

    
    
  • objects(VirtualObject) / set_objects(Option<Vec::<VirtualObject>>):
    required: true
    

    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>

impl Client

pub fn deregister_resource(&self) -> DeregisterResourceFluentBuilder

Constructs a fluent builder for the DeregisterResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource that you want to deregister.

    
    
• On success, responds with DeregisterResourceOutput
• On failure, responds with SdkError<DeregisterResourceError>

impl Client

pub fn describe_lake_formation_identity_center_configuration( &self ) -> DescribeLakeFormationIdentityCenterConfigurationFluentBuilder

Constructs a fluent builder for the DescribeLakeFormationIdentityCenterConfiguration operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

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

  • instance_arn(Option<String>):

    The Amazon Resource Name (ARN) of the connection.

  • application_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Lake Formation application integrated with IAM Identity Center.

  • external_filtering(Option<ExternalFilteringConfiguration>):

    Indicates if external filtering is enabled.

  • share_recipients(Option<Vec::<DataLakePrincipal>>):

    A list of Amazon Web Services account IDs or Amazon Web Services organization/organizational unit ARNs that are allowed to access data managed by Lake Formation.

    If the ShareRecipients list includes valid values, a resource share is created with the principals you want to have access to the resources as the ShareRecipients.

    If the ShareRecipients value is null or the list is empty, no resource share is created.

  • resource_share(Option<String>):

    The Amazon Resource Name (ARN) of the RAM share.

• On failure, responds with SdkError<DescribeLakeFormationIdentityCenterConfigurationError>

impl Client

pub fn describe_resource(&self) -> DescribeResourceFluentBuilder

Constructs a fluent builder for the DescribeResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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>

impl Client

pub fn describe_transaction(&self) -> DescribeTransactionFluentBuilder

Constructs a fluent builder for the DescribeTransaction operation.

• The fluent builder is configurable:
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn extend_transaction(&self) -> ExtendTransactionFluentBuilder

Constructs a fluent builder for the ExtendTransaction operation.

• The fluent builder is configurable:
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: false
    

    The transaction to extend.

    
    
• On success, responds with ExtendTransactionOutput
• On failure, responds with SdkError<ExtendTransactionError>

impl Client

pub fn get_data_cells_filter(&self) -> GetDataCellsFilterFluentBuilder

Constructs a fluent builder for the GetDataCellsFilter operation.

• The fluent builder is configurable:
  • table_catalog_id(impl Into<String>) / set_table_catalog_id(Option<String>):
    required: true
    

    The ID of the catalog to which the table belongs.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

    A database in the Glue Data Catalog.

    
    
  • table_name(impl Into<String>) / set_table_name(Option<String>):
    required: true
    

    A table in the database.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name given by the user to the data filter cell.

    
    
• On success, responds with GetDataCellsFilterOutput with field(s):
  • data_cells_filter(Option<DataCellsFilter>):

    A structure that describes certain columns on certain rows.

• On failure, responds with SdkError<GetDataCellsFilterError>

impl Client

pub fn get_data_lake_settings(&self) -> GetDataLakeSettingsFluentBuilder

Constructs a fluent builder for the GetDataLakeSettings operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>

impl Client

pub fn get_effective_permissions_for_path( &self ) -> GetEffectivePermissionsForPathFluentBuilder

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>):
    required: false
    

    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>):
    required: true
    

    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>):
    required: false
    

    A continuation token, if this is not the first call to retrieve this list.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>

impl Client

pub fn get_lf_tag(&self) -> GetLFTagFluentBuilder

Constructs a fluent builder for the GetLFTag operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    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>

impl Client

pub fn get_query_state(&self) -> GetQueryStateFluentBuilder

Constructs a fluent builder for the GetQueryState operation.

• The fluent builder is configurable:
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    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(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>

impl Client

pub fn get_query_statistics(&self) -> GetQueryStatisticsFluentBuilder

Constructs a fluent builder for the GetQueryStatistics operation.

• The fluent builder is configurable:
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    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>

impl Client

pub fn get_resource_lf_tags(&self) -> GetResourceLFTagsFluentBuilder

Constructs a fluent builder for the GetResourceLFTags operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    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>):
    required: false
    

    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>

impl Client

pub fn get_table_objects(&self) -> GetTableObjectsFluentBuilder

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>):
    required: false
    

    The catalog containing the governed table. Defaults to the caller’s account.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

    The database containing the governed table.

    
    
  • table_name(impl Into<String>) / set_table_name(Option<String>):
    required: true
    

    The governed table for which to retrieve objects.

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    Specifies how many values to return in a page.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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>

impl Client

pub fn get_temporary_glue_partition_credentials( &self ) -> GetTemporaryGluePartitionCredentialsFluentBuilder

Constructs a fluent builder for the GetTemporaryGluePartitionCredentials operation.

• The fluent builder is configurable:
  • table_arn(impl Into<String>) / set_table_arn(Option<String>):
    required: true
    

    The ARN of the partitions’ table.

    
    
  • partition(PartitionValueList) / set_partition(Option<PartitionValueList>):
    required: true
    

    A list of partition values identifying a single partition.

    
    
  • permissions(Permission) / set_permissions(Option<Vec::<Permission>>):
    required: false
    

    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>):
    required: false
    

    The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.

    
    
  • audit_context(AuditContext) / set_audit_context(Option<AuditContext>):
    required: false
    

    A structure representing context to access a resource (column names, query ID, etc).

    
    
  • supported_permission_types(PermissionType) / set_supported_permission_types(Option<Vec::<PermissionType>>):
    required: false
    

    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>

impl Client

pub fn get_temporary_glue_table_credentials( &self ) -> GetTemporaryGlueTableCredentialsFluentBuilder

Constructs a fluent builder for the GetTemporaryGlueTableCredentials operation.

• The fluent builder is configurable:
  • table_arn(impl Into<String>) / set_table_arn(Option<String>):
    required: true
    

    The ARN identifying a table in the Data Catalog for the temporary credentials request.

    
    
  • permissions(Permission) / set_permissions(Option<Vec::<Permission>>):
    required: false
    

    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>):
    required: false
    

    The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.

    
    
  • audit_context(AuditContext) / set_audit_context(Option<AuditContext>):
    required: false
    

    A structure representing context to access a resource (column names, query ID, etc).

    
    
  • supported_permission_types(PermissionType) / set_supported_permission_types(Option<Vec::<PermissionType>>):
    required: false
    

    A list of supported permission types for the table. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.

    
    
  • s3_path(impl Into<String>) / set_s3_path(Option<String>):
    required: false
    

    The Amazon S3 path for the table.

    
    
  • query_session_context(QuerySessionContext) / set_query_session_context(Option<QuerySessionContext>):
    required: false
    

    A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request’s authorization context.

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

  • vended_s3_path(Option<Vec::<String>>):

    The Amazon S3 path for the temporary credentials.

• On failure, responds with SdkError<GetTemporaryGlueTableCredentialsError>

impl Client

pub fn get_work_unit_results(&self) -> GetWorkUnitResultsFluentBuilder

Constructs a fluent builder for the GetWorkUnitResults operation.

• The fluent builder is configurable:
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The ID of the plan query operation for which to get results.

    
    
  • work_unit_id(i64) / set_work_unit_id(Option<i64>):
    required: true
    

    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>):
    required: true
    

    A work token used to query the execution service. Token output from GetWorkUnits.

    
    
• On success, responds with GetWorkUnitResultsOutput with field(s):
  • result_stream(ByteStream):

    Rows returned from the GetWorkUnitResults operation as a stream of Apache Arrow v1.0 messages.

• On failure, responds with SdkError<GetWorkUnitResultsError>

impl Client

pub fn get_work_units(&self) -> GetWorkUnitsFluentBuilder

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>):
    required: false
    

    A continuation token, if this is a continuation call.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    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>):
    required: true
    

    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(String):

    The ID of the plan query operation.

  • work_unit_ranges(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>

impl Client

pub fn grant_permissions(&self) -> GrantPermissionsFluentBuilder

Constructs a fluent builder for the GrantPermissions operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    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>):
    required: true
    

    The resource to which permissions are to be granted. Resources in Lake Formation are the Data Catalog, databases, and tables.

    
    
  • permissions(Permission) / set_permissions(Option<Vec::<Permission>>):
    required: true
    

    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(Permission) / set_permissions_with_grant_option(Option<Vec::<Permission>>):
    required: false
    

    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>

impl Client

pub fn list_data_cells_filter(&self) -> ListDataCellsFilterFluentBuilder

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>):
    required: false
    

    A table in the Glue Data Catalog.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A continuation token, if this is a continuation call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_lake_formation_opt_ins( &self ) -> ListLakeFormationOptInsFluentBuilder

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

• The fluent builder is configurable:
  • principal(DataLakePrincipal) / set_principal(Option<DataLakePrincipal>):
    required: false
    

    The Lake Formation principal. Supported principals are IAM users or IAM roles.

    
    
  • resource(Resource) / set_resource(Option<Resource>):
    required: false
    

    A structure for the resource.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A continuation token, if this is not the first call to retrieve this list.

    
    
• On success, responds with ListLakeFormationOptInsOutput with field(s):
  • lake_formation_opt_ins_info_list(Option<Vec::<LakeFormationOptInsInfo>>):

    A list of principal-resource pairs that have Lake Formation permissins enforced.

  • next_token(Option<String>):

    A continuation token, if this is not the first call to retrieve this list.

• On failure, responds with SdkError<ListLakeFormationOptInsError>

impl Client

pub fn list_lf_tags(&self) -> ListLFTagsFluentBuilder

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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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>

impl Client

pub fn list_permissions(&self) -> ListPermissionsFluentBuilder

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>):
    required: false
    

    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>):
    required: false
    

    Specifies a principal to filter the permissions returned.

    
    
  • resource_type(DataLakeResourceType) / set_resource_type(Option<DataLakeResourceType>):
    required: false
    

    Specifies a resource type to filter the permissions returned.

    
    
  • resource(Resource) / set_resource(Option<Resource>):
    required: false
    

    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>):
    required: false
    

    A continuation token, if this is not the first call to retrieve this list.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • include_related(impl Into<String>) / set_include_related(Option<String>):
    required: false
    

    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>

impl Client

pub fn list_resources(&self) -> ListResourcesFluentBuilder

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

• The fluent builder is configurable:
  • filter_condition_list(FilterCondition) / set_filter_condition_list(Option<Vec::<FilterCondition>>):
    required: false
    

    Any applicable row-level and/or column-level filtering conditions for the resources.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of resource results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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>

impl Client

pub fn list_table_storage_optimizers( &self ) -> ListTableStorageOptimizersFluentBuilder

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>):
    required: false
    

    The Catalog ID of the table.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

    Name of the database where the table is present.

    
    
  • table_name(impl Into<String>) / set_table_name(Option<String>):
    required: true
    

    Name of the table.

    
    
  • storage_optimizer_type(OptimizerType) / set_storage_optimizer_type(Option<OptimizerType>):
    required: false
    

    The specific type of storage optimizers to list. The supported value is compaction.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of storage optimizers to return on each call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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>

impl Client

pub fn list_transactions(&self) -> ListTransactionsFluentBuilder

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>):
    required: false
    

    The catalog for which to list transactions. Defaults to the account ID of the caller.

    
    
  • status_filter(TransactionStatusFilter) / set_status_filter(Option<TransactionStatusFilter>):
    required: false
    

    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>):
    required: false
    

    The maximum number of transactions to return in a single call.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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>

impl Client

pub fn put_data_lake_settings(&self) -> PutDataLakeSettingsFluentBuilder

Constructs a fluent builder for the PutDataLakeSettings operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    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>

impl Client

pub fn register_resource(&self) -> RegisterResourceFluentBuilder

Constructs a fluent builder for the RegisterResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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>):
    required: false
    

    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>):
    required: false
    

    The identifier for the role that registers the resource.

    
    
  • with_federation(bool) / set_with_federation(Option<bool>):
    required: false
    

    Whether or not the resource is a federated resource.

    
    
  • hybrid_access_enabled(bool) / set_hybrid_access_enabled(Option<bool>):
    required: false
    

    Specifies whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.

    
    
• On success, responds with RegisterResourceOutput
• On failure, responds with SdkError<RegisterResourceError>

impl Client

pub fn remove_lf_tags_from_resource( &self ) -> RemoveLFTagsFromResourceFluentBuilder

Constructs a fluent builder for the RemoveLFTagsFromResource operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    The database, table, or column resource where you want to remove an LF-tag.

    
    
  • lf_tags(LfTagPair) / set_lf_tags(Option<Vec::<LfTagPair>>):
    required: true
    

    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>

impl Client

pub fn revoke_permissions(&self) -> RevokePermissionsFluentBuilder

Constructs a fluent builder for the RevokePermissions operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    The principal to be revoked permissions on the resource.

    
    
  • resource(Resource) / set_resource(Option<Resource>):
    required: true
    

    The resource to which permissions are to be revoked.

    
    
  • permissions(Permission) / set_permissions(Option<Vec::<Permission>>):
    required: true
    

    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(Permission) / set_permissions_with_grant_option(Option<Vec::<Permission>>):
    required: false
    

    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>

impl Client

pub fn search_databases_by_lf_tags( &self ) -> SearchDatabasesByLFTagsFluentBuilder

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>):
    required: false
    

    A continuation token, if this is not the first call to retrieve this list.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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(LfTag) / set_expression(Option<Vec::<LfTag>>):
    required: true
    

    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>

impl Client

pub fn search_tables_by_lf_tags(&self) -> SearchTablesByLFTagsFluentBuilder

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>):
    required: false
    

    A continuation token, if this is not the first call to retrieve this list.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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(LfTag) / set_expression(Option<Vec::<LfTag>>):
    required: true
    

    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. On the first run, if you include a not null (a value) token you can get empty pages.

  • table_list(Option<Vec::<TaggedTable>>):

    A list of tables that meet the LF-tag conditions.

• On failure, responds with SdkError<SearchTablesByLFTagsError>

impl Client

pub fn start_query_planning(&self) -> StartQueryPlanningFluentBuilder

Constructs a fluent builder for the StartQueryPlanning operation.

• The fluent builder is configurable:
  • query_planning_context(QueryPlanningContext) / set_query_planning_context(Option<QueryPlanningContext>):
    required: true
    

    A structure containing information about the query plan.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    A PartiQL query statement used as an input to the planner service.

    
    
• On success, responds with StartQueryPlanningOutput with field(s):
  • query_id(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>

impl Client

pub fn start_transaction(&self) -> StartTransactionFluentBuilder

Constructs a fluent builder for the StartTransaction operation.

• The fluent builder is configurable:
  • transaction_type(TransactionType) / set_transaction_type(Option<TransactionType>):
    required: false
    

    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>

impl Client

pub fn update_data_cells_filter(&self) -> UpdateDataCellsFilterFluentBuilder

Constructs a fluent builder for the UpdateDataCellsFilter operation.

• The fluent builder is configurable:
  • table_data(DataCellsFilter) / set_table_data(Option<DataCellsFilter>):
    required: true
    

    A DataCellsFilter structure containing information about the data cells filter.

    
    
• On success, responds with UpdateDataCellsFilterOutput
• On failure, responds with SdkError<UpdateDataCellsFilterError>

impl Client

pub fn update_lake_formation_identity_center_configuration( &self ) -> UpdateLakeFormationIdentityCenterConfigurationFluentBuilder

Constructs a fluent builder for the UpdateLakeFormationIdentityCenterConfiguration operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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, view definitions, and other control information to manage your Lake Formation environment.

    
    
  • share_recipients(DataLakePrincipal) / set_share_recipients(Option<Vec::<DataLakePrincipal>>):
    required: false
    

    A list of Amazon Web Services account IDs or Amazon Web Services organization/organizational unit ARNs that are allowed to access to access data managed by Lake Formation.

    If the ShareRecipients list includes valid values, then the resource share is updated with the principals you want to have access to the resources.

    If the ShareRecipients value is null, both the list of share recipients and the resource share remain unchanged.

    If the ShareRecipients value is an empty list, then the existing share recipients list will be cleared, and the resource share will be deleted.

    
    
  • application_status(ApplicationStatus) / set_application_status(Option<ApplicationStatus>):
    required: false
    

    Allows to enable or disable the IAM Identity Center connection.

    
    
  • external_filtering(ExternalFilteringConfiguration) / set_external_filtering(Option<ExternalFilteringConfiguration>):
    required: false
    

    A list of the account IDs of Amazon Web Services accounts of third-party applications that are allowed to access data managed by Lake Formation.

    
    
• On success, responds with UpdateLakeFormationIdentityCenterConfigurationOutput
• On failure, responds with SdkError<UpdateLakeFormationIdentityCenterConfigurationError>

impl Client

pub fn update_lf_tag(&self) -> UpdateLFTagFluentBuilder

Constructs a fluent builder for the UpdateLFTag operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    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>):
    required: true
    

    The key-name for the LF-tag for which to add or delete values.

    
    
  • tag_values_to_delete(impl Into<String>) / set_tag_values_to_delete(Option<Vec::<String>>):
    required: false
    

    A list of LF-tag values to delete from the LF-tag.

    
    
  • tag_values_to_add(impl Into<String>) / set_tag_values_to_add(Option<Vec::<String>>):
    required: false
    

    A list of LF-tag values to add from the LF-tag.

    
    
• On success, responds with UpdateLfTagOutput
• On failure, responds with SdkError<UpdateLFTagError>

impl Client

pub fn update_resource(&self) -> UpdateResourceFluentBuilder

Constructs a fluent builder for the UpdateResource operation.

• The fluent builder is configurable:
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The new role to use for the given resource registered in Lake Formation.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The resource ARN.

    
    
  • with_federation(bool) / set_with_federation(Option<bool>):
    required: false
    

    Whether or not the resource is a federated resource.

    
    
  • hybrid_access_enabled(bool) / set_hybrid_access_enabled(Option<bool>):
    required: false
    

    Specifies whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.

    
    
• On success, responds with UpdateResourceOutput
• On failure, responds with SdkError<UpdateResourceError>

impl Client

pub fn update_table_objects(&self) -> UpdateTableObjectsFluentBuilder

Constructs a fluent builder for the UpdateTableObjects operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    The catalog containing the governed table to update. Defaults to the caller’s account ID.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

    The database containing the governed table to update.

    
    
  • table_name(impl Into<String>) / set_table_name(Option<String>):
    required: true
    

    The governed table to update.

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: false
    

    The transaction at which to do the write.

    
    
  • write_operations(WriteOperation) / set_write_operations(Option<Vec::<WriteOperation>>):
    required: true
    

    A list of WriteOperation objects that define an object to add to or delete from the manifest for a governed table.

    
    
• On success, responds with UpdateTableObjectsOutput
• On failure, responds with SdkError<UpdateTableObjectsError>

impl Client

pub fn update_table_storage_optimizer( &self ) -> UpdateTableStorageOptimizerFluentBuilder

Constructs a fluent builder for the UpdateTableStorageOptimizer operation.

• The fluent builder is configurable:
  • catalog_id(impl Into<String>) / set_catalog_id(Option<String>):
    required: false
    

    The Catalog ID of the table.

    
    
  • database_name(impl Into<String>) / set_database_name(Option<String>):
    required: true
    

    Name of the database where the table is present.

    
    
  • table_name(impl Into<String>) / set_table_name(Option<String>):
    required: true
    

    Name of the table for which to enable the storage optimizer.

    
    
  • storage_optimizer_config(OptimizerType, HashMap::<String, String>) / set_storage_optimizer_config(Option<HashMap::<OptimizerType, HashMap::<String, String>>>):
    required: true
    

    Name of the table for which to enable the storage optimizer.

    
    
• On success, responds with UpdateTableStorageOptimizerOutput with field(s):
  • result(Option<String>):

    A response indicating the success of failure of the operation.

• On failure, responds with SdkError<UpdateTableStorageOptimizerError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.