aws_sdk_glue/client/
get_tables.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetTables`](crate::operation::get_tables::builders::GetTablesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_tables::builders::GetTablesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`catalog_id(impl Into<String>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::catalog_id) / [`set_catalog_id(Option<String>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::set_catalog_id):<br>required: **false**<br><p>The ID of the Data Catalog where the tables reside. If none is provided, the Amazon Web Services account ID is used by default.</p><br>
8    ///   - [`database_name(impl Into<String>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::database_name) / [`set_database_name(Option<String>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::set_database_name):<br>required: **true**<br><p>The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.</p><br>
9    ///   - [`expression(impl Into<String>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::expression) / [`set_expression(Option<String>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::set_expression):<br>required: **false**<br><p>A regular expression pattern. If present, only those tables whose names match the pattern are returned.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::set_next_token):<br>required: **false**<br><p>A continuation token, included if this is a continuation call.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of tables to return in a single response.</p><br>
12    ///   - [`transaction_id(impl Into<String>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::transaction_id) / [`set_transaction_id(Option<String>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::set_transaction_id):<br>required: **false**<br><p>The transaction ID at which to read the table contents.</p><br>
13    ///   - [`query_as_of_time(DateTime)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::query_as_of_time) / [`set_query_as_of_time(Option<DateTime>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::set_query_as_of_time):<br>required: **false**<br><p>The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with <code>TransactionId</code>.</p><br>
14    ///   - [`include_status_details(bool)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::include_status_details) / [`set_include_status_details(Option<bool>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::set_include_status_details):<br>required: **false**<br><p>Specifies whether to include status details related to a request to create or update an Glue Data Catalog view.</p><br>
15    ///   - [`attributes_to_get(TableAttributes)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::attributes_to_get) / [`set_attributes_to_get(Option<Vec::<TableAttributes>>)`](crate::operation::get_tables::builders::GetTablesFluentBuilder::set_attributes_to_get):<br>required: **false**<br><p>Specifies the table fields returned by the <code>GetTables</code> call. This parameter doesn’t accept an empty list. The request must include <code>NAME</code>.</p> <p>The following are the valid combinations of values:</p> <ul>  <li>   <p><code>NAME</code> - Names of all tables in the database.</p></li>  <li>   <p><code>NAME</code>, <code>TABLE_TYPE</code> - Names of all tables and the table types.</p></li> </ul><br>
16    /// - On success, responds with [`GetTablesOutput`](crate::operation::get_tables::GetTablesOutput) with field(s):
17    ///   - [`table_list(Option<Vec::<Table>>)`](crate::operation::get_tables::GetTablesOutput::table_list): <p>A list of the requested <code>Table</code> objects.</p>
18    ///   - [`next_token(Option<String>)`](crate::operation::get_tables::GetTablesOutput::next_token): <p>A continuation token, present if the current list segment is not the last.</p>
19    /// - On failure, responds with [`SdkError<GetTablesError>`](crate::operation::get_tables::GetTablesError)
20    pub fn get_tables(&self) -> crate::operation::get_tables::builders::GetTablesFluentBuilder {
21        crate::operation::get_tables::builders::GetTablesFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_glue/client/get_tables.rs

aws_sdk_glue/client/
get_tables.rs
