AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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 Amazon Web Services IoT Core pricing - Messaging.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ListRetainedMessagesAsync.

Namespace: Amazon.IotData
Assembly: AWSSDK.IotData.dll
Version: 3.x.y.z

Syntax

C#
public virtual ListRetainedMessagesResponse ListRetainedMessages(
         ListRetainedMessagesRequest request
)

Parameters

request
Type: Amazon.IotData.Model.ListRetainedMessagesRequest

Container for the necessary parameters to execute the ListRetainedMessages service method.

Return Value


The response from the ListRetainedMessages service method, as returned by IotData.

Exceptions

ExceptionCondition
InternalFailureException An unexpected error has occurred.
InvalidRequestException The request is not valid.
MethodNotAllowedException The specified combination of HTTP verb and URI is not supported.
ServiceUnavailableException The service is temporarily unavailable.
ThrottlingException The rate exceeds the limit.
UnauthorizedException You are not authorized to perform this operation.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also