aws_sdk_connectcases/client/

search_all_related_items.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`SearchAllRelatedItems`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_id(impl Into<String>)`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::set_domain_id):<br>required: **true**<br><p>The unique identifier of the Cases domain.</p><br>
    ///   - [`max_results(i32)`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::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>
    ///   - [`filters(RelatedItemTypeFilter)`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::filters) / [`set_filters(Option<Vec::<RelatedItemTypeFilter>>)`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::set_filters):<br>required: **false**<br><p>The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.</p><br>
    ///   - [`sorts(SearchAllRelatedItemsSort)`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::sorts) / [`set_sorts(Option<Vec::<SearchAllRelatedItemsSort>>)`](crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::set_sorts):<br>required: **false**<br><p>A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.</p><br>
    /// - On success, responds with [`SearchAllRelatedItemsOutput`](crate::operation::search_all_related_items::SearchAllRelatedItemsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::search_all_related_items::SearchAllRelatedItemsOutput::next_token): <p>The token for the next set of results. This is null if there are no more results to return.</p>
    ///   - [`related_items(Vec::<Option<SearchAllRelatedItemsResponseItem>>)`](crate::operation::search_all_related_items::SearchAllRelatedItemsOutput::related_items): <p>A list of items related to a case.</p>
    /// - On failure, responds with [`SdkError<SearchAllRelatedItemsError>`](crate::operation::search_all_related_items::SearchAllRelatedItemsError)
    pub fn search_all_related_items(&self) -> crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder {
        crate::operation::search_all_related_items::builders::SearchAllRelatedItemsFluentBuilder::new(self.handle.clone())
    }
}