aws_sdk_connect/client/search_views.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 [`SearchViews`](crate::operation::search_views::builders::SearchViewsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_views::builders::SearchViewsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`instance_id(impl Into<String>)`](crate::operation::search_views::builders::SearchViewsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::search_views::builders::SearchViewsFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::search_views::builders::SearchViewsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_views::builders::SearchViewsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
9 /// - [`max_results(i32)`](crate::operation::search_views::builders::SearchViewsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_views::builders::SearchViewsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
10 /// - [`search_filter(ViewSearchFilter)`](crate::operation::search_views::builders::SearchViewsFluentBuilder::search_filter) / [`set_search_filter(Option<ViewSearchFilter>)`](crate::operation::search_views::builders::SearchViewsFluentBuilder::set_search_filter):<br>required: **false**<br><p>Filters to apply to the search, such as tag-based filters.</p><br>
11 /// - [`search_criteria(ViewSearchCriteria)`](crate::operation::search_views::builders::SearchViewsFluentBuilder::search_criteria) / [`set_search_criteria(Option<ViewSearchCriteria>)`](crate::operation::search_views::builders::SearchViewsFluentBuilder::set_search_criteria):<br>required: **false**<br><p>The search criteria, including field names and comparison types.</p><br>
12 /// - On success, responds with [`SearchViewsOutput`](crate::operation::search_views::SearchViewsOutput) with field(s):
13 /// - [`views(Option<Vec::<View>>)`](crate::operation::search_views::SearchViewsOutput::views): <p>A list of views that match the search criteria.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::search_views::SearchViewsOutput::next_token): <p>If there are additional results, this is the token for the next set of results.</p>
15 /// - [`approximate_total_count(Option<i64>)`](crate::operation::search_views::SearchViewsOutput::approximate_total_count): <p>The approximate total number of views that match the search criteria.</p>
16 /// - On failure, responds with [`SdkError<SearchViewsError>`](crate::operation::search_views::SearchViewsError)
17 pub fn search_views(&self) -> crate::operation::search_views::builders::SearchViewsFluentBuilder {
18 crate::operation::search_views::builders::SearchViewsFluentBuilder::new(self.handle.clone())
19 }
20}