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.
This is an asynchronous operation using the standard naming convention for .NET 4.7.2 or higher.
Namespace: Amazon.IotData
Assembly: AWSSDK.IotData.dll
Version: 3.x.y.z
public virtual Task<ListRetainedMessagesResponse> ListRetainedMessagesAsync( ListRetainedMessagesRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the ListRetainedMessages service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| 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. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer