aws_sdk_connectcases/client/
search_cases.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchCases`](crate::operation::search_cases::builders::SearchCasesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_id(impl Into<String>)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::set_domain_id):<br>required: **true**<br><p>The unique identifier of the Cases domain.</p><br>
    ///   - [`max_results(i32)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::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>
    ///   - [`search_term(impl Into<String>)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::search_term) / [`set_search_term(Option<String>)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::set_search_term):<br>required: **false**<br><p>A word or phrase used to perform a quick search.</p><br>
    ///   - [`filter(CaseFilter)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::filter) / [`set_filter(Option<CaseFilter>)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::set_filter):<br>required: **false**<br><p>A list of filter objects.</p><br>
    ///   - [`sorts(Sort)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::sorts) / [`set_sorts(Option<Vec::<Sort>>)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::set_sorts):<br>required: **false**<br><p>A list of sorts where each sort specifies a field and their sort order to be applied to the results.</p><br>
    ///   - [`fields(FieldIdentifier)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::fields) / [`set_fields(Option<Vec::<FieldIdentifier>>)`](crate::operation::search_cases::builders::SearchCasesFluentBuilder::set_fields):<br>required: **false**<br><p>The list of field identifiers to be returned as part of the response.</p><br>
    /// - On success, responds with [`SearchCasesOutput`](crate::operation::search_cases::SearchCasesOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::search_cases::SearchCasesOutput::next_token): <p>The token for the next set of results. This is null if there are no more results to return.</p>
    ///   - [`cases(Vec::<Option<SearchCasesResponseItem>>)`](crate::operation::search_cases::SearchCasesOutput::cases): <p>A list of case documents where each case contains the properties <code>CaseId</code> and <code>Fields</code> where each field is a complex union structure.</p>
    /// - On failure, responds with [`SdkError<SearchCasesError>`](crate::operation::search_cases::SearchCasesError)
    pub fn search_cases(&self) -> crate::operation::search_cases::builders::SearchCasesFluentBuilder {
        crate::operation::search_cases::builders::SearchCasesFluentBuilder::new(self.handle.clone())
    }
}