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 AWS IoT Core pricing - Messaging.
Request SyntaxGET /retainedMessage?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
The maximum number of results to return at one time.
Valid Range: Minimum value of 1. Maximum value of 200.
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
The request does not have a request body.
Response SyntaxHTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"retainedTopics": [
{
"lastModifiedTime": number,
"payloadSize": number,
"qos": number,
"topic": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
The token for the next set of results, or null if there are no additional results.
Type: String
A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.
Type: Array of RetainedMessageSummary objects
An unexpected error has occurred.
HTTP Status Code: 500
The request is not valid.
HTTP Status Code: 400
The specified combination of HTTP verb and URI is not supported.
HTTP Status Code: 405
The service is temporarily unavailable.
HTTP Status Code: 503
The rate exceeds the limit.
HTTP Status Code: 429
You are not authorized to perform this operation.
HTTP Status Code: 401
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4