v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1474530.7 KB

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.

get/retainedMessage

Query parameters

nextTokenstring

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.

maxResultsinteger

The maximum number of results to return at one time.

Response

Success

nextTokenstring

The token for the next set of results, or null if there are no additional results.