aws_sdk_cloudtrail/client/

search_sample_queries.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchSampleQueries`](crate::operation::search_sample_queries::builders::SearchSampleQueriesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`search_phrase(impl Into<String>)`](crate::operation::search_sample_queries::builders::SearchSampleQueriesFluentBuilder::search_phrase) / [`set_search_phrase(Option<String>)`](crate::operation::search_sample_queries::builders::SearchSampleQueriesFluentBuilder::set_search_phrase):<br>required: **true**<br><p>The natural language phrase to use for the semantic search. The phrase must be in English. The length constraint is in characters, not words.</p><br>
    ///   - [`max_results(i32)`](crate::operation::search_sample_queries::builders::SearchSampleQueriesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_sample_queries::builders::SearchSampleQueriesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return on a single page. The default value is 10.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::search_sample_queries::builders::SearchSampleQueriesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_sample_queries::builders::SearchSampleQueriesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token you can use to get the next page of results. The length constraint is in characters, not words.</p><br>
    /// - On success, responds with [`SearchSampleQueriesOutput`](crate::operation::search_sample_queries::SearchSampleQueriesOutput) with field(s):
    ///   - [`search_results(Option<Vec::<SearchSampleQueriesSearchResult>>)`](crate::operation::search_sample_queries::SearchSampleQueriesOutput::search_results): <p>A list of objects containing the search results ordered from most relevant to least relevant.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::search_sample_queries::SearchSampleQueriesOutput::next_token): <p>A token you can use to get the next page of results.</p>
    /// - On failure, responds with [`SdkError<SearchSampleQueriesError>`](crate::operation::search_sample_queries::SearchSampleQueriesError)
    pub fn search_sample_queries(&self) -> crate::operation::search_sample_queries::builders::SearchSampleQueriesFluentBuilder {
        crate::operation::search_sample_queries::builders::SearchSampleQueriesFluentBuilder::new(self.handle.clone())
    }
}