| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.IoTData.ListRetainedMessages
Description
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 operation returns paginated results.
Synopsis
- data ListRetainedMessages = ListRetainedMessages' {}
- newListRetainedMessages :: ListRetainedMessages
- listRetainedMessages_maxResults :: Lens' ListRetainedMessages (Maybe Natural)
- listRetainedMessages_nextToken :: Lens' ListRetainedMessages (Maybe Text)
- data ListRetainedMessagesResponse = ListRetainedMessagesResponse' {}
- newListRetainedMessagesResponse :: Int -> ListRetainedMessagesResponse
- listRetainedMessagesResponse_nextToken :: Lens' ListRetainedMessagesResponse (Maybe Text)
- listRetainedMessagesResponse_retainedTopics :: Lens' ListRetainedMessagesResponse (Maybe [RetainedMessageSummary])
- listRetainedMessagesResponse_httpStatus :: Lens' ListRetainedMessagesResponse Int
Creating a Request
data ListRetainedMessages Source #
See: newListRetainedMessages smart constructor.
Constructors
| ListRetainedMessages' | |
Instances
newListRetainedMessages :: ListRetainedMessages Source #
Create a value of ListRetainedMessages with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListRetainedMessages', listRetainedMessages_maxResults - The maximum number of results to return at one time.
ListRetainedMessages, listRetainedMessages_nextToken - To retrieve the next set of results, the nextToken value from a
previous response; otherwise null to receive the first set of
results.
Request Lenses
listRetainedMessages_maxResults :: Lens' ListRetainedMessages (Maybe Natural) Source #
The maximum number of results to return at one time.
listRetainedMessages_nextToken :: Lens' ListRetainedMessages (Maybe Text) Source #
To retrieve the next set of results, the nextToken value from a
previous response; otherwise null to receive the first set of
results.
Destructuring the Response
data ListRetainedMessagesResponse Source #
See: newListRetainedMessagesResponse smart constructor.
Constructors
| ListRetainedMessagesResponse' | |
Fields
| |
Instances
newListRetainedMessagesResponse Source #
Create a value of ListRetainedMessagesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRetainedMessages, listRetainedMessagesResponse_nextToken - The token for the next set of results, or null if there are no
additional results.
$sel:retainedTopics:ListRetainedMessagesResponse', listRetainedMessagesResponse_retainedTopics - A summary list the account's retained messages. The information
returned doesn't include the message payloads of the retained messages.
$sel:httpStatus:ListRetainedMessagesResponse', listRetainedMessagesResponse_httpStatus - The response's http status code.
Response Lenses
listRetainedMessagesResponse_nextToken :: Lens' ListRetainedMessagesResponse (Maybe Text) Source #
The token for the next set of results, or null if there are no additional results.
listRetainedMessagesResponse_retainedTopics :: Lens' ListRetainedMessagesResponse (Maybe [RetainedMessageSummary]) Source #
A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.
listRetainedMessagesResponse_httpStatus :: Lens' ListRetainedMessagesResponse Int Source #
The response's http status code.