aws_sdk_lakeformation/client/

get_table_objects.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetTableObjects`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`catalog_id(impl Into<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::catalog_id) / [`set_catalog_id(Option<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::set_catalog_id):<br>required: **false**<br><p>The catalog containing the governed table. Defaults to the caller’s account.</p><br>
    ///   - [`database_name(impl Into<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::database_name) / [`set_database_name(Option<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::set_database_name):<br>required: **true**<br><p>The database containing the governed table.</p><br>
    ///   - [`table_name(impl Into<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::table_name) / [`set_table_name(Option<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::set_table_name):<br>required: **true**<br><p>The governed table for which to retrieve objects.</p><br>
    ///   - [`transaction_id(impl Into<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::transaction_id) / [`set_transaction_id(Option<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::set_transaction_id):<br>required: **false**<br><p>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 <code>QueryAsOfTime</code>.</p><br>
    ///   - [`query_as_of_time(DateTime)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::query_as_of_time) / [`set_query_as_of_time(Option<DateTime>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::set_query_as_of_time):<br>required: **false**<br><p>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 <code>TransactionId</code>.</p><br>
    ///   - [`partition_predicate(impl Into<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::partition_predicate) / [`set_partition_predicate(Option<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::set_partition_predicate):<br>required: **false**<br><p>A predicate to filter the objects returned based on the partition keys defined in the governed table.</p> <ul>  <li>   <p>The comparison operators supported are: =, &gt;, &lt;, &gt;=, &lt;=</p></li>  <li>   <p>The logical operators supported are: AND</p></li>  <li>   <p>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.</p></li> </ul><br>
    ///   - [`max_results(i32)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::set_max_results):<br>required: **false**<br><p>Specifies how many values to return in a page.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::set_next_token):<br>required: **false**<br><p>A continuation token if this is not the first call to retrieve these objects.</p><br>
    /// - On success, responds with [`GetTableObjectsOutput`](crate::operation::get_table_objects::GetTableObjectsOutput) with field(s):
    ///   - [`objects(Option<Vec::<PartitionObjects>>)`](crate::operation::get_table_objects::GetTableObjectsOutput::objects): <p>A list of objects organized by partition keys.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_table_objects::GetTableObjectsOutput::next_token): <p>A continuation token indicating whether additional data is available.</p>
    /// - On failure, responds with [`SdkError<GetTableObjectsError>`](crate::operation::get_table_objects::GetTableObjectsError)
    pub fn get_table_objects(&self) -> crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder {
        crate::operation::get_table_objects::builders::GetTableObjectsFluentBuilder::new(self.handle.clone())
    }
}