aws_sdk_connect/client/
search_data_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 [`SearchDataTables`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`instance_id(impl Into<String>)`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::set_instance_id):<br>required: **true**<br><p>The unique identifier for the Amazon Connect instance to search within.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::set_next_token):<br>required: **false**<br><p>Specify the pagination token from a previous request to retrieve the next page of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of data tables to return in one page of results.</p><br>
10    ///   - [`search_filter(DataTableSearchFilter)`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::search_filter) / [`set_search_filter(Option<DataTableSearchFilter>)`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::set_search_filter):<br>required: **false**<br><p>Optional filters to apply to the search results, such as tag-based filtering for attribute-based access control.</p><br>
11    ///   - [`search_criteria(DataTableSearchCriteria)`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::search_criteria) / [`set_search_criteria(Option<DataTableSearchCriteria>)`](crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::set_search_criteria):<br>required: **false**<br><p>Search criteria including string conditions for matching table names, descriptions, or resource IDs. Supports STARTS_WITH, CONTAINS, and EXACT comparison types.</p><br>
12    /// - On success, responds with [`SearchDataTablesOutput`](crate::operation::search_data_tables::SearchDataTablesOutput) with field(s):
13    ///   - [`data_tables(Option<Vec::<DataTable>>)`](crate::operation::search_data_tables::SearchDataTablesOutput::data_tables): <p>An array of data tables matching the search criteria with the same structure as DescribeTable except Version, VersionDescription, and LockVersion are omitted.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::search_data_tables::SearchDataTablesOutput::next_token): <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
15    ///   - [`approximate_total_count(Option<i64>)`](crate::operation::search_data_tables::SearchDataTablesOutput::approximate_total_count): <p>The approximate number of data tables that matched the search criteria.</p>
16    /// - On failure, responds with [`SdkError<SearchDataTablesError>`](crate::operation::search_data_tables::SearchDataTablesError)
17    pub fn search_data_tables(&self) -> crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder {
18        crate::operation::search_data_tables::builders::SearchDataTablesFluentBuilder::new(self.handle.clone())
19    }
20}