Struct aws_sdk_iotdataplane::client::fluent_builders::ListRetainedMessages

pub struct ListRetainedMessages<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to ListRetainedMessages.

Lists summary information about the retained messages stored for the account.

This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs.

To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message.

Requires permission to access the ListRetainedMessages action.

For more information about messaging costs, see IoT Core pricing - Messaging.

Implementations

impl<C, M, R> ListRetainedMessages<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<ListRetainedMessagesOutput, SdkError<ListRetainedMessagesError>> where
    R::Policy: SmithyRetryPolicy<ListRetainedMessagesInputOperationOutputAlias, ListRetainedMessagesOutput, ListRetainedMessagesError, ListRetainedMessagesInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> ListRetainedMessagesPaginator<C, M, R>

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn next_token(self, input: impl Into<String>) -> Self

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

pub fn set_next_token(self, input: Option<String>) -> Self

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return at one time.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return at one time.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for ListRetainedMessages<C, M, R>

fn clone(&self) -> ListRetainedMessages<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for ListRetainedMessages<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.