aws_sdk_connect/client/
search_notifications.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 [`SearchNotifications`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_id(impl Into<String>)`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::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>
7    ///   - [`next_token(impl Into<String>)`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page. Valid range is 1-100.</p><br>
9    ///   - [`search_filter(NotificationSearchFilter)`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::search_filter) / [`set_search_filter(Option<NotificationSearchFilter>)`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::set_search_filter):<br>required: **false**<br><p>Filters to apply to the search results, such as tag-based filters.</p><br>
10    ///   - [`search_criteria(NotificationSearchCriteria)`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::search_criteria) / [`set_search_criteria(Option<NotificationSearchCriteria>)`](crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::set_search_criteria):<br>required: **false**<br><p>The search criteria to apply when searching for notifications. Supports filtering by notification ID and message content using comparison types such as STARTS_WITH, CONTAINS, and EXACT.</p><br>
11    /// - On success, responds with [`SearchNotificationsOutput`](crate::operation::search_notifications::SearchNotificationsOutput) with field(s):
12    ///   - [`notifications(Option<Vec::<NotificationSearchSummary>>)`](crate::operation::search_notifications::SearchNotificationsOutput::notifications): <p>A list of notifications matching the search criteria.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::search_notifications::SearchNotificationsOutput::next_token): <p>The token for the next set of results. If present, there are more results available.</p>
14    ///   - [`approximate_total_count(Option<i64>)`](crate::operation::search_notifications::SearchNotificationsOutput::approximate_total_count): <p>The approximate total number of notifications matching the search criteria.</p>
15    /// - On failure, responds with [`SdkError<SearchNotificationsError>`](crate::operation::search_notifications::SearchNotificationsError)
16    pub fn search_notifications(&self) -> crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder {
17        crate::operation::search_notifications::builders::SearchNotificationsFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_connect/client/search_notifications.rs

aws_sdk_connect/client/
search_notifications.rs
