aws_sdk_iotdataplane/client/
list_retained_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 [`ListRetainedMessages`](crate::operation::list_retained_messages::builders::ListRetainedMessagesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_retained_messages::builders::ListRetainedMessagesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_retained_messages::builders::ListRetainedMessagesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_retained_messages::builders::ListRetainedMessagesFluentBuilder::set_next_token):<br>required: **false**<br><p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_retained_messages::builders::ListRetainedMessagesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_retained_messages::builders::ListRetainedMessagesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return at one time.</p><br>
9    /// - On success, responds with [`ListRetainedMessagesOutput`](crate::operation::list_retained_messages::ListRetainedMessagesOutput) with field(s):
10    ///   - [`retained_topics(Option<Vec::<RetainedMessageSummary>>)`](crate::operation::list_retained_messages::ListRetainedMessagesOutput::retained_topics): <p>A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_retained_messages::ListRetainedMessagesOutput::next_token): <p>The token for the next set of results, or null if there are no additional results.</p>
12    /// - On failure, responds with [`SdkError<ListRetainedMessagesError>`](crate::operation::list_retained_messages::ListRetainedMessagesError)
13    pub fn list_retained_messages(&self) -> crate::operation::list_retained_messages::builders::ListRetainedMessagesFluentBuilder {
14        crate::operation::list_retained_messages::builders::ListRetainedMessagesFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_iotdataplane/client/list_retained_messages.rs

aws_sdk_iotdataplane/client/
list_retained_messages.rs
