aws_sdk_qconnect/client/
list_messages.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 [`ListMessages`](crate::operation::list_messages::builders::ListMessagesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`assistant_id(impl Into<String>)`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::set_assistant_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect assistant.</p><br>
8    ///   - [`session_id(impl Into<String>)`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::set_session_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect session.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::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>
10    ///   - [`max_results(i32)`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
11    ///   - [`filter(MessageFilterType)`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::filter) / [`set_filter(Option<MessageFilterType>)`](crate::operation::list_messages::builders::ListMessagesFluentBuilder::set_filter):<br>required: **false**<br><p>The filter criteria for listing messages.</p><br>
12    /// - On success, responds with [`ListMessagesOutput`](crate::operation::list_messages::ListMessagesOutput) with field(s):
13    ///   - [`messages(Vec::<MessageOutput>)`](crate::operation::list_messages::ListMessagesOutput::messages): <p>The message information.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_messages::ListMessagesOutput::next_token): <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>
15    /// - On failure, responds with [`SdkError<ListMessagesError>`](crate::operation::list_messages::ListMessagesError)
16    pub fn list_messages(&self) -> crate::operation::list_messages::builders::ListMessagesFluentBuilder {
17        crate::operation::list_messages::builders::ListMessagesFluentBuilder::new(self.handle.clone())
18    }
19}